add a bunch of emacs packages HELP

2 files changed, 129 insertions, 0 deletions

diff --git a/.config/emacs/lisp/evil-collection/modes/gptel/README.org b/.config/emacs/lisp/evil-collection/modes/gptel/README.org
new file mode 100644
index 0000000..903e622
--- /dev/null
+++ b/.config/emacs/lisp/evil-collection/modes/gptel/README.org
@@ -0,0 +1,47 @@
+* gptel
+
+  Evil bindings for [[https://github.com/karthink/gptel][gptel]].
+
+  =RET= submission follows =evil-collection-repl-submit-state=: in the submit
+  state, =RET= sends; in the other state (insert when submit is normal, normal
+  when submit is insert), =RET= inserts a newline. =S-RET= behavior is
+  controlled by two customs.
+
+** Key bindings
+
+*** gptel-mode-map
+
+    Upstream only binds =C-c RET= to =gptel-send=; =RET= itself is unchanged
+    on the buffer's major mode. Evil-collection layers state-aware =RET= /
+    =S-RET= behavior on top.
+
+    | Command      | Original  | Evil                                                             |
+    |--------------+-----------+------------------------------------------------------------------|
+    | =gptel-send= | =C-c RET= | =C-c RET=                                                        |
+    | =gptel-send= | n/a       | =RET=, =<return>= in submit state                                |
+    | =newline=    | n/a       | =S-RET=, =S-<return>= in submit state; all four in newline state |
+    | =gptel-menu= | n/a       | =S-RET=, =<S-return>= in normal / visual (default)               |
+    | =gptel-send= | =C-c RET= | =S-RET=, =<S-return>= in normal / visual (when menu custom nil)  |
+
+*** gptel-context-buffer-mode-map (normal state)
+
+    | Command                       | Original  | Evil      |
+    |-------------------------------+-----------+-----------|
+    | =gptel-context-next=          | =n=       | =j=       |
+    | =gptel-context-previous=      | =p=       | =k=       |
+    | =gptel-context-flag-deletion= | =d=       | =d=       |
+    | =gptel-context-quit=          | =C-c C-k= | =q=, =ZQ= |
+    | =gptel-context-confirm=       | =C-c C-c= | =ZZ=      |
+    | =gptel-context-visit=         | =RET=     | =RET=     |
+
+** Customization
+
+   | Variable                                       | Default | Purpose                                                                     |
+   |------------------------------------------------+---------+-----------------------------------------------------------------------------|
+   | =evil-collection-gptel-want-shift-ret-to-send= | =t=     | Bind =S-RET= in normal / visual to =gptel-send=.                            |
+   | =evil-collection-gptel-want-shift-ret-menu=    | =t=     | Bind =S-RET= in normal / visual to =gptel-menu=. Wins over the send custom. |
+
+** Integrations
+
+   =gptel-context=: bindings for the context buffer (above) are wired via
+   =with-eval-after-load 'gptel-context=.
diff --git a/.config/emacs/lisp/evil-collection/modes/gptel/evil-collection-gptel.el b/.config/emacs/lisp/evil-collection/modes/gptel/evil-collection-gptel.el
new file mode 100644
index 0000000..6be9535
--- /dev/null
+++ b/.config/emacs/lisp/evil-collection/modes/gptel/evil-collection-gptel.el
@@ -0,0 +1,82 @@
+;;; evil-collection-gptel.el --- Bindings for gptel -*- lexical-binding: t -*-
+
+;; Copyright (C) 2024 James Nguyen
+
+;; Author: James Nguyen <james@jojojames.com>
+;; Maintainer: James Nguyen <james@jojojames.com>, Zhiwei Chen <condy0919@gmail.com>
+;; URL: https://github.com/emacs-evil/evil-collection
+;; Version: 0.0.1
+;; Package-Requires: ((emacs "26.3"))
+;; Keywords: emacs
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+;;; Bindings for gptel.
+
+;;; Code:
+(require 'evil-collection)
+(require 'gptel nil t)
+
+
+(defconst evil-collection-gptel-maps
+  '(gptel-mode-map gptel-context-buffer-mode-map))
+
+(defcustom evil-collection-gptel-want-shift-ret-to-send t
+  "When non nil, S-RET sends query to LLM."
+  :group 'evil-collection
+  :type 'boolean)
+
+(defcustom evil-collection-gptel-want-shift-ret-menu t
+  "When non nil, S-RET opens calls `gptel-menu'. This takes priority over
+ `evil-collection-gptel-want-shift-ret-to-send'."
+  :group 'evil-collection
+  :type 'boolean)
+
+;;;###autoload
+(defun evil-collection-gptel-setup ()
+  "Set up `evil' bindings for gptel."
+  (let* ((submit evil-collection-repl-submit-state)
+         (newline-state (if (eq submit 'normal) 'insert 'normal)))
+    (evil-collection-define-key submit 'gptel-mode-map
+      (kbd "RET") 'gptel-send
+      (kbd "<return>") 'gptel-send
+      (kbd "S-RET") 'newline
+      (kbd "S-<return>") 'newline)
+    (evil-collection-define-key newline-state 'gptel-mode-map
+      (kbd "RET") 'newline
+      (kbd "<return>") 'newline
+      (kbd "S-RET") 'newline
+      (kbd "S-<return>") 'newline))
+  (if evil-collection-gptel-want-shift-ret-menu
+      (evil-collection-define-key '(normal visual) 'gptel-mode-map
+        (kbd "S-RET") 'gptel-menu
+        (kbd "<S-return>") 'gptel-menu)
+    (when evil-collection-gptel-want-shift-ret-to-send
+      (evil-collection-define-key '(normal visual) 'gptel-mode-map
+        (kbd "S-RET") 'gptel-send
+        (kbd "<S-return>") 'gptel-send)))
+
+  (with-eval-after-load 'gptel-context
+    (evil-collection-define-key 'normal 'gptel-context-buffer-mode-map
+      "j" 'gptel-context-next
+      "k" 'gptel-context-previous
+      "d" 'gptel-context-flag-deletion
+      "q" 'gptel-context-quit
+      "ZQ" 'gptel-context-quit
+      "ZZ" 'gptel-context-confirm
+      (kbd "RET") 'gptel-context-visit)))
+
+(provide 'evil-collection-gptel)
+;;; evil-collection-gptel.el ends here