add a bunch of emacs packages HELP

2 files changed, 417 insertions, 0 deletions

diff --git a/.config/emacs/lisp/evil-collection/modes/cider/README.org b/.config/emacs/lisp/evil-collection/modes/cider/README.org
new file mode 100644
index 0000000..a72a3a7
--- /dev/null
+++ b/.config/emacs/lisp/evil-collection/modes/cider/README.org
@@ -0,0 +1,164 @@
+* cider
+
+  Evil bindings for [[https://github.com/clojure-emacs/cider][CIDER]].
+
+  The bulk of CIDER's commands live under the =C-c= prefix in =cider-mode-map=
+  -- those are left alone. Evil only adds vim-style navigation, doc lookup and
+  the debugger keys.
+
+** cider-mode-map
+
+   | Command                          | Original      | Evil      |
+   |----------------------------------+---------------+-----------|
+   | =cider-switch-to-repl-buffer=    | =C-c C-z=     | =gz=      |
+   | =cider-find-resource=            | =C-c M-.=     | =gf=      |
+   | =cider-doc=                      | =C-c C-d C-d= | =K=       |
+   | =cider-find-var=                 | =M-.=         | =gd=  ([[#xref][†]]) |
+   | =cider-pop-back=                 | =M-,=         | =C-t= ([[#xref][†]]) |
+   | =cider-browse-instrumented-defs= | n/a           | =<f6>=    |
+   | =cider-debug-defun-at-point=     | =C-u C-M-x=   | =<f9>=    |
+
+   The =<f6>= / =<f9>= bindings only fire when
+   =evil-collection-setup-debugger-keys= is non-nil.
+
+** cider-repl-mode-map
+
+   | Command                               | Original      | Evil                                         |
+   |---------------------------------------+---------------+----------------------------------------------|
+   | =cider-switch-to-last-clojure-buffer= | =C-c C-z=     | =gz=                                         |
+   | =cider-refresh=                       | =C-c M-n r=   | =gr=                                         |
+   | =cider-find-resource=                 | =C-c M-.=     | =gf=                                         |
+   | =cider-doc=                           | =C-c C-d C-d= | =K=                                          |
+   | =cider-find-var=                      | =M-.=         | =gd=  ([[#xref][†]])                                    |
+   | =cider-pop-back=                      | =M-,=         | =C-t= ([[#xref][†]])                                    |
+   | =cider-repl-return=                   | =RET=         | =RET= in =evil-collection-repl-submit-state= |
+   | =newline=                             | =C-j=         | =RET= in the opposite state                  |
+
+   See =evil-collection-repl-submit-state= (normal or insert) for which state
+   submits.
+
+** cider-repl-history-mode-map
+
+   | Command                                | Original | Evil              |
+   |----------------------------------------+----------+-------------------|
+   | =cider-repl-history-previous=          | =p=      | =C-k=, =gk=, =[[= |
+   | =cider-repl-history-forward=           | =n=      | =C-j=, =gj=, =]]= |
+   | =cider-repl-history-insert-and-quit=   | =RET=    | =RET=             |
+   | =cider-repl-history-update=            | =g=      | =gr=              |
+   | =cider-repl-history-quit=              | =q=      | =q=               |
+   | =cider-repl-history-undo-other-window= | =U=      | =u=               |
+
+** cider-test-report-mode-map
+
+   | Command                            | Original   | Evil               |
+   |------------------------------------+------------+--------------------|
+   | =cider-test-commands-map=          | n/a        | =C-c ,=, =C-c C-t= |
+   | =cider-test-previous-result=       | n/a        | =M-p=, =<backtab>= |
+   | =cider-test-next-result=           | =TAB=      | =M-n=, =<tab>=     |
+   | =cider-test-jump=                  | =t=, =RET= | =gd=, =t=, =RET=   |
+   | =cider-test-ediff=                 | =d=        | =d=                |
+   | =cider-test-stacktrace=            | =e=        | =e=                |
+   | =cider-test-rerun-failed-tests=    | =f=        | =f=                |
+   | =cider-test-run-ns-tests=          | =n=        | =n=                |
+   | =cider-test-run-loaded-tests=      | =l=        | =L=                |
+   | =cider-test-run-project-tests=     | =p=        | =p=                |
+   | =cider-test-run-test=              | =g=        | =gr=               |
+   | =cider-popup-buffer-quit-function= | n/a        | =q=                |
+
+** cider-macroexpansion-mode-map
+
+   | Command                                    | Original | Evil        |
+   |--------------------------------------------+----------+-------------|
+   | =cider-popup-buffer-quit-function=         | n/a      | =q=         |
+   | =cider-macroexpand-again=                  | =g=      | =r=         |
+   | =cider-doc=                                | =d=      | =K=         |
+   | =cider-javadoc=                            | =j=      | =J=         |
+   | =cider-find-var= / =xref-find-definitions= | =.=      | =.=         |
+   | =cider-macroexpand-1-inplace=              | =m=      | =m=         |
+   | =cider-macroexpand-all-inplace=            | =a=      | =a=         |
+   | =cider-macroexpand-undo=                   | =u=      | =u=, =undo= |
+
+** cider-connections-buffer-mode-map
+
+   | Command                              | Original | Evil  |
+   |--------------------------------------+----------+-------|
+   | =cider-connections-make-default=     | n/a      | =d=   |
+   | =cider-connection-browser=           | n/a      | =c=   |
+   | =cider-connections-close-connection= | n/a      | =x=   |
+   | =cider-connections-goto-connection=  | n/a      | =RET= |
+   | =describe-mode=                      | n/a      | =g?=  |
+
+** cider-stacktrace-mode-map
+
+   Initial evil state is forced to normal.
+
+   | Command                                | Original | Evil              |
+   |----------------------------------------+----------+-------------------|
+   | =cider-stacktrace-previous-cause=      | n/a      | =C-k=, =gk=, =[[= |
+   | =cider-stacktrace-next-cause=          | n/a      | =C-j=, =gj=, =]]= |
+   | =cider-stacktrace-jump=                | n/a      | =gd=              |
+   | =cider-popup-buffer-quit-function=     | =q=      | =q=               |
+   | =cider-stacktrace-toggle-java=         | =j=      | =J=               |
+   | =cider-stacktrace-toggle-clj=          | =c=      | =C=               |
+   | =cider-stacktrace-toggle-repl=         | =r=      | =R=               |
+   | =cider-stacktrace-toggle-tooling=      | =t=      | =T=               |
+   | =cider-stacktrace-toggle-duplicates=   | =d=      | =D=               |
+   | =cider-stacktrace-show-only-project=   | =p=      | =P=               |
+   | =cider-stacktrace-toggle-all=          | =a=      | =A=               |
+   | =cider-stacktrace-cycle-cause-1..5=    | =1..5=   | =1..5=            |
+   | =cider-stacktrace-cycle-all-causes=    | =0=      | =0=, =<backtab>=  |
+   | =cider-stacktrace-cycle-current-cause= | =TAB=    | =TAB=             |
+
+** cider-inspector-mode-map
+
+   | Command                                       | Original     | Evil         |
+   |-----------------------------------------------+--------------+--------------|
+   | =quit-window=                                 | n/a          | =q=          |
+   | =cider-inspector-operate-on-point=            | =RET=        | =RET=        |
+   | =cider-inspector-pop=                         | =l=          | =L=          |
+   | =cider-inspector-refresh=                     | =g=          | =gr=         |
+   | =cider-inspector-next-page=                   | =SPC=        | =C-j=, =SPC= |
+   | =cider-inspector-prev-page=                   | =S-SPC=      | =C-k=        |
+   | =cider-inspector-set-page-size=               | =s=          | =s=          |
+   | =cider-inspector-next-inspectable-object=     | =n=, =TAB=   | =]]=, =gj=   |
+   | =cider-inspector-previous-inspectable-object= | =p=, =S-TAB= | =[[=, =gk=   |
+
+** cider--debug-mode-map
+
+   Only active when =evil-collection-setup-debugger-keys= is non-nil. Each key
+   sends a reply through =cider-debug-mode-send-reply=.
+
+   | Command                                      | Reply             | Evil |
+   |----------------------------------------------+-------------------+------|
+   | =cider-debug-defun-at-point=                 | (re-instrument)   | =b=  |
+   | =evil-collection-cider-debug-continue=       | =:continue=       | =c=  |
+   | =evil-collection-cider-debug-continue-all=   | =:continue-all=   | =C=  |
+   | =evil-collection-cider-debug-next=           | =:next=           | =n=  |
+   | =evil-collection-cider-debug-in=             | =:in=             | =I=  |
+   | =evil-collection-cider-debug-out=            | =:out=            | =o=  |
+   | =evil-collection-cider-debug-force-out=      | =:force-out=      | =O=  |
+   | =cider-debug-move-here=                      | (move here)       | =H=  |
+   | =evil-collection-cider-debug-eval=           | =:eval=           | =e=  |
+   | =evil-collection-cider-debug-inspect=        | =:inspect=        | =p=  |
+   | =evil-collection-cider-debug-inspect-prompt= | =:inspect-prompt= | =P=  |
+   | =evil-collection-cider-debug-locals=         | =:locals=         | =L=  |
+   | =evil-collection-cider-debug-inject=         | =:inject=         | =J=  |
+   | =evil-collection-cider-debug-stacktrace=     | =:stacktrace=     | =s=  |
+   | =evil-collection-cider-debug-trace=          | =:trace=          | =t=  |
+   | =evil-collection-cider-debug-quit=           | =:quit=           | =q=  |
+
+** New commands
+
+   | Command                           | Purpose                                                                                              |
+   |-----------------------------------+------------------------------------------------------------------------------------------------------|
+   | =evil-collection-cider-debug-*=   | One per cider-debug reply keyword (see =cider--debug-mode-map=).                                     |
+   | =evil-collection-cider-last-sexp= | Advice for =cider-eval-last-sexp= so the last sexp ends at point when =evil-move-beyond-eol= is nil. |
+
+** Xref fallbacks
+   :PROPERTIES:
+   :CUSTOM_ID: xref
+   :END:
+
+   =gd= / =C-t= are only bound when =cider-use-xref= is nil. With xref enabled
+   the user already has =M-.= / =M-,= going through =xref-find-definitions= and
+   nothing extra is added.
diff --git a/.config/emacs/lisp/evil-collection/modes/cider/evil-collection-cider.el b/.config/emacs/lisp/evil-collection/modes/cider/evil-collection-cider.el
new file mode 100644
index 0000000..e8ec712
--- /dev/null
+++ b/.config/emacs/lisp/evil-collection/modes/cider/evil-collection-cider.el
@@ -0,0 +1,253 @@
+;;; evil-collection-cider.el --- Evil bindings for Cider -*- lexical-binding: t -*-
+
+;; Copyright (C) 2017, 2024 James Nguyen
+
+;; Author: James Nguyen <james@jojojames.com>
+;; Maintainer: James Nguyen <james@jojojames.com>
+;; Pierre Neidhardt <mail@ambrevar.xyz>
+;; URL: https://github.com/emacs-evil/evil-collection
+;; Version: 0.0.1
+;; Package-Requires: ((emacs "26.3"))
+;; Keywords: evil, cider, tools
+
+;; 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:
+;; Evil bindings for Cider.
+
+;;; Code:
+(require 'cl-lib)
+(require 'cider nil t)
+(require 'evil-collection)
+
+(defvar cider-use-xref)
+
+(declare-function cider-debug-mode-send-reply "cider-debug")
+
+(defconst evil-collection-cider-maps '(cider-mode-map
+                                       cider-repl-mode-map
+                                       cider-repl-history-mode-map
+                                       cider-test-report-mode-map
+                                       cider-macroexpansion-mode-map
+                                       cider-connections-buffer-mode-map))
+
+(defun evil-collection-cider-last-sexp (command &rest args)
+  "In normal-state or motion-state, last sexp ends at point."
+  (if (and (not evil-move-beyond-eol)
+           (or (evil-normal-state-p) (evil-motion-state-p)))
+      (save-excursion
+        (unless (or (eobp) (eolp)) (forward-char))
+        (apply command args))
+    (apply command args)))
+
+(defmacro evil-collection-cider-make-debug-command (&rest cider-commands)
+  "Make functions that wrap `cider-debug' commands.
+
+Cider debug commands are sent through `cider-debug-mode-send-reply'.
+
+ex. \(cider-debug-mode-send-reply \":next\"\)"
+  (let ((commands (if (consp cider-commands)
+                      cider-commands
+                    (list cider-commands))))
+    `(progn
+       ,@(cl-loop
+          for command in commands
+          collect
+          (let ((funsymbol
+                 (intern (format "evil-collection-cider-debug-%s" command))))
+            `(defun ,funsymbol ()
+               ,(format
+                 "Send :%s to `cider-debug-mode-send-reply'." command)
+               (interactive)
+               (cider-debug-mode-send-reply ,(format ":%s" command))))))))
+
+(evil-collection-cider-make-debug-command "continue"
+                                          "continue-all"
+                                          "next"
+                                          "in"
+                                          "out"
+                                          "force-out"
+                                          "eval"
+                                          "inspect"
+                                          "inspect-prompt"
+                                          "locals"
+                                          "inject"
+                                          "stacktrace"
+                                          "trace"
+                                          "quit")
+
+;;;###autoload
+(defun evil-collection-cider-setup ()
+  "Set up `evil' bindings for `cider'."
+  (unless evil-move-beyond-eol
+    (advice-add 'cider-eval-last-sexp :around 'evil-collection-cider-last-sexp)
+    (advice-add 'cider-eval-last-sexp-and-replace :around 'evil-collection-cider-last-sexp)
+    (advice-add 'cider-eval-last-sexp-to-repl :around 'evil-collection-cider-last-sexp)
+    (with-eval-after-load 'cider-eval-sexp-fu
+      (advice-add 'cider-esf--bounds-of-last-sexp :around 'evil-collection-cider-last-sexp)))
+
+  (when evil-collection-setup-debugger-keys
+    (add-hook 'cider-mode-hook #'evil-normalize-keymaps)
+    (add-hook 'cider--debug-mode-hook #'evil-normalize-keymaps)
+    (evil-collection-define-key 'normal 'cider-mode-map
+      [f6] 'cider-browse-instrumented-defs
+      [f9] 'cider-debug-defun-at-point)
+
+    (evil-collection-define-key 'normal 'cider--debug-mode-map
+      "b" 'cider-debug-defun-at-point
+      "c" 'evil-collection-cider-debug-continue
+      "C" 'evil-collection-cider-debug-continue-all
+      "n" 'evil-collection-cider-debug-next
+      "I" 'evil-collection-cider-debug-in
+      "o" 'evil-collection-cider-debug-out
+      "O" 'evil-collection-cider-debug-force-out
+      "H" 'cider-debug-move-here
+      "e" 'evil-collection-cider-debug-eval
+      "p" 'evil-collection-cider-debug-inspect
+      "P" 'evil-collection-cider-debug-inspect-prompt
+      "L" 'evil-collection-cider-debug-locals
+      "J" 'evil-collection-cider-debug-inject
+      "s" 'evil-collection-cider-debug-stacktrace
+      "t" 'evil-collection-cider-debug-trace
+      "q" 'evil-collection-cider-debug-quit))
+
+  (evil-collection-define-key '(normal visual) 'cider-mode-map
+    "gz" 'cider-switch-to-repl-buffer
+    "gf" 'cider-find-resource
+    "K" 'cider-doc)
+
+  (unless cider-use-xref
+    (evil-collection-define-key '(normal visual) 'cider-mode-map
+      "gd" 'cider-find-var
+      (kbd "C-t") 'cider-pop-back))
+
+  (evil-collection-define-key '(normal visual) 'cider-repl-mode-map
+    ;; FIXME: This seems to get overwritten by `cider-switch-to-repl-buffer'.
+    "gz" 'cider-switch-to-last-clojure-buffer
+    "gr" 'cider-refresh
+    "gf" 'cider-find-resource
+    "K" 'cider-doc)
+
+  (let* ((submit evil-collection-repl-submit-state)
+         (newline-state (if (eq submit 'normal) 'insert 'normal)))
+    (evil-collection-define-key submit 'cider-repl-mode-map
+      (kbd "RET") 'cider-repl-return)
+    (evil-collection-define-key newline-state 'cider-repl-mode-map
+      (kbd "RET") 'newline))
+
+  (unless cider-use-xref
+    (evil-collection-define-key '(normal visual) 'cider-repl-mode-map
+      "gd" 'cider-find-var
+      (kbd "C-t") 'cider-pop-back))
+
+  (evil-collection-define-key '(normal visual) 'cider-repl-history-mode-map
+    (kbd "C-k") 'cider-repl-history-previous
+    (kbd "C-j") 'cider-repl-history-forward
+    "gk" 'cider-repl-history-previous
+    "gj" 'cider-repl-history-forward
+    "[[" 'cider-repl-history-previous
+    "]]" 'cider-repl-history-forward
+
+    (kbd "RET") 'cider-repl-history-insert-and-quit
+    "gr" 'cider-repl-history-update
+    "q" 'cider-repl-history-quit
+    "u" 'cider-repl-history-undo-other-window)
+
+  (evil-collection-define-key 'normal 'cider-test-report-mode-map
+    (kbd "C-c ,") 'cider-test-commands-map
+    (kbd "C-c C-t") 'cider-test-commands-map
+    (kbd "M-p") 'cider-test-previous-result
+    (kbd "M-n") 'cider-test-next-result
+
+    ;; goto
+    "gd" 'cider-test-jump
+
+    (kbd "<backtab>") 'cider-test-previous-result
+    (kbd "<tab>") 'cider-test-next-result
+    (kbd "RET") 'cider-test-jump
+    "t" 'cider-test-jump
+    "d" 'cider-test-ediff
+    "e" 'cider-test-stacktrace
+    "f" 'cider-test-rerun-failed-tests
+    "n" 'cider-test-run-ns-tests
+    "L" 'cider-test-run-loaded-tests
+    "p" 'cider-test-run-project-tests
+    "gr" 'cider-test-run-test
+    "q" 'cider-popup-buffer-quit-function)
+
+  (evil-collection-define-key 'normal 'cider-macroexpansion-mode-map
+    ;; quit
+    "q" 'cider-popup-buffer-quit-function
+
+    "r" 'cider-macroexpand-again
+    "K" 'cider-doc ; Evil has `evil-lookup'.
+    "J" 'cider-javadoc
+    "." (if cider-use-xref 'xref-find-definitions 'cider-find-var)
+    "m" 'cider-macroexpand-1-inplace
+    "a" 'cider-macroexpand-all-inplace
+    "u" 'cider-macroexpand-undo
+    [remap undo] 'cider-macroexpand-undo)
+
+  (evil-collection-define-key 'normal 'cider-connections-buffer-mode-map
+    "d" 'cider-connections-make-default
+    "c" 'cider-connection-browser
+    "x" 'cider-connections-close-connection
+    (kbd "RET") 'cider-connections-goto-connection
+    "g?" 'describe-mode)
+
+  (evil-set-initial-state 'cider-stacktrace-mode 'normal)
+  (evil-collection-define-key 'normal 'cider-stacktrace-mode-map
+    (kbd "C-k") 'cider-stacktrace-previous-cause
+    (kbd "C-j") 'cider-stacktrace-next-cause
+    (kbd "gk") 'cider-stacktrace-previous-cause
+    (kbd "gj") 'cider-stacktrace-next-cause
+    (kbd "[[") 'cider-stacktrace-previous-cause
+    (kbd "]]") 'cider-stacktrace-next-cause
+    "gd" 'cider-stacktrace-jump
+    "q" 'cider-popup-buffer-quit-function
+    "J" 'cider-stacktrace-toggle-java
+    "C" 'cider-stacktrace-toggle-clj
+    "R" 'cider-stacktrace-toggle-repl
+    "T" 'cider-stacktrace-toggle-tooling
+    "D" 'cider-stacktrace-toggle-duplicates
+    "P" 'cider-stacktrace-show-only-project
+    "A" 'cider-stacktrace-toggle-all
+    "1" 'cider-stacktrace-cycle-cause-1
+    "2" 'cider-stacktrace-cycle-cause-2
+    "3" 'cider-stacktrace-cycle-cause-3
+    "4" 'cider-stacktrace-cycle-cause-4
+    "5" 'cider-stacktrace-cycle-cause-5
+    "0" 'cider-stacktrace-cycle-all-causes
+    (kbd "TAB") 'cider-stacktrace-cycle-current-cause
+    [backtab] 'cider-stacktrace-cycle-all-causes)
+
+  (add-hook 'cider-inspector-mode-hook #'evil-normalize-keymaps)
+  (evil-collection-define-key 'normal 'cider-inspector-mode-map
+    "q" 'quit-window
+    (kbd "RET") 'cider-inspector-operate-on-point
+    [mouse-1] 'cider-inspector-operate-on-click
+    "L" 'cider-inspector-pop
+    "gr" 'cider-inspector-refresh
+    ;; Page-up/down
+    (kbd "C-j") 'cider-inspector-next-page
+    (kbd "C-k") 'cider-inspector-prev-page
+    " " 'cider-inspector-next-page
+    "s" 'cider-inspector-set-page-size
+    (kbd "]]") 'cider-inspector-next-inspectable-object
+    (kbd "[[") 'cider-inspector-previous-inspectable-object
+    "gj" 'cider-inspector-next-inspectable-object
+    "gk" 'cider-inspector-previous-inspectable-object))
+
+(provide 'evil-collection-cider)
+;;; evil-collection-cider.el ends here