refactor(evil)!: move all Evil related configs/packages to me-evil

NOTE: I'm moving away from Evil to the classic Emacs experience (maybe with
Meow). I've left the `me-evil` module as it is with all the Evil related
packages in this same module. I will spend some time on Emacs/Meow to see if it
fits for me.

Author: abougouffa

core/me-builtin.el

@@ -481,9 +481,7 @@ or file path may exist now."
     "j"   #'next-line
     "k"   #'previous-line
     "q"   #'kill-buffer-and-window
-    "ESC" #'kill-buffer-and-window)
-  (with-eval-after-load 'evil
-    (add-hook 'reftex-mode-hook #'evil-normalize-keymaps)))
+    "ESC" #'kill-buffer-and-window))
 
 (use-package bibtex
   :hook (bibtex-mode . display-line-numbers-mode)
@@ -817,10 +815,6 @@ This variable should be set early, either in \"early-config.el\" or \"init-tweak
   :preface
   ;; Set to nil so we can detect user changes (in config.el)
   (setq org-directory nil)
-  (with-eval-after-load 'evil
-    ;; Fix `evil' search problem (to be used with `evil-search')
-    (when (eq evil-search-module 'evil-search)
-      (setq org-fold-core-style 'overlays)))
   :custom
   (org-auto-align-tags nil)
   (org-clock-persist-file (concat minemacs-cache-dir "org/clock-persist.el"))
@@ -847,7 +841,7 @@ This variable should be set early, either in \"early-config.el\" or \"init-tweak
   (org-pretty-entities-include-sub-superscripts t)
   (org-preview-latex-image-directory (+directory-ensure minemacs-cache-dir "org/preview/latex-image/"))
   (org-publish-timestamp-directory (+directory-ensure minemacs-cache-dir "org/publish/timestamps/"))
-  (org-return-follows-link t) ; RET follows link (a key bind has to be defined for Evil, see below)
+  (org-return-follows-link t) ; RET follows link (a key bind has to be defined for Evil, (see `me-evil'))
   (org-special-ctrl-a/e t)
   (org-startup-indented nil)
   (org-tags-column 0)
@@ -875,8 +869,6 @@ This variable should be set early, either in \"early-config.el\" or \"init-tweak
     "s" #'org-edit-src-save
     "q" #'org-edit-src-abort
     "e" #'org-edit-src-exit)
-  (+nmap! :keymaps 'org-mode-map
-    "RET" #'org-open-at-point)
 
   (setq org-export-async-debug minemacs-debug-p) ;; Can be useful!
 

core/me-evil.el

@@ -108,6 +108,284 @@
     "gc" #'evilnc-comment-operator
     "gC" #'evilnc-copy-and-comment-operator))
 
+(cl-defmacro +evil-conf-for! (package module &optional &key init-form &key config-form)
+  (declare (indent 2))
+  `(when (and (not (+package-disabled-p ',package ',module))
+          (memq ',module (append minemacs-core-modules minemacs-modules)))
+    ,init-form
+    ,(when config-form
+      `(with-eval-after-load ',package ,config-form))))
+
+
+
+;;; For `me-multi-cursors'
+
+(use-package evil-multiedit ; This will load `iedit' and suppresses it
+  :straight t
+  :unless (+package-disabled-p 'iedit 'me-multi-cursors)
+  :after evil minemacs-first-file
+  :demand
+  :init
+  (+nvmap! :infix "g"
+    "ze" '(nil :wk "evil-multiedit")
+    "zee" #'evil-multiedit-match-all
+    "zer" #'evil-multiedit-restore
+    "zeq" #'evil-multiedit-abort
+    "zen" #'evil-multiedit-next
+    "zeN" #'evil-multiedit-prev
+    "zet" #'evil-multiedit-toggle-or-restrict-region)
+  (+vmap! :infix "g"
+    "zed" #'evil-multiedit-match-and-next
+    "zeD" #'evil-multiedit-match-and-prev)
+  (+nmap! :infix "g"
+    "zed" #'evil-multiedit-match-symbol-and-next
+    "zeD" #'evil-multiedit-match-symbol-and-prev
+    "zeT" #'evil-multiedit-toggle-marker-here)
+  :config
+  (evil-multiedit-default-keybinds))
+
+(use-package evil-iedit-state
+  :straight t
+  :unless (+package-disabled-p 'iedit 'me-multi-cursors)
+  :commands evil-iedit-state/iedit-mode
+  :after iedit
+  :init
+  ;; Use the `iedit' key to trigger `evil-iedit-state/iedit-mode'.
+  (when iedit-toggle-key-default
+    (keymap-global-set (key-description iedit-toggle-key-default) 'evil-iedit-state/iedit-mode))
+  :config
+  ;; FIX: When we press "C-;" (`iedit-toggle-key-default') to enter `iedit-mode'
+  ;; and then "C-;" to quit it, `evil-iedit-state' will stay in `iedit-mode'
+  ;; even if the selections aren't displayed and no `iedit' indication is
+  ;; displayed in minibuffer.
+  (when iedit-toggle-key-default
+    (keymap-set evil-iedit-state-map (key-description iedit-toggle-key-default) 'evil-iedit-state/quit-iedit-mode)))
+
+(use-package evil-mc
+  :straight t
+  :when (memq 'me-multi-cursors minemacs-modules)
+  :hook (minemacs-first-file . global-evil-mc-mode)
+  :config
+  ;; Use "gz" instead of "gr", this last is mapped to `xref-find-references' in some programming modes.
+  (evil-define-key* '(normal visual) evil-mc-key-map (kbd "gr") nil)
+  (evil-define-key* '(normal visual) evil-mc-key-map (kbd "gz") evil-mc-cursors-map)
+
+  ;; Add support to repeat these commands when prefixed with a number
+  (dolist (cmd '(evil-mc-make-and-goto-first-cursor evil-mc-make-and-goto-last-cursor
+                 evil-mc-make-and-goto-prev-cursor evil-mc-make-and-goto-next-cursor
+                 evil-mc-skip-and-goto-prev-cursor evil-mc-skip-and-goto-next-cursor
+                 evil-mc-make-and-goto-prev-match evil-mc-make-and-goto-next-match
+                 evil-mc-skip-and-goto-prev-match evil-mc-skip-and-goto-next-match))
+    (let ((fn-name (intern (format "+%s--repeat:around-a" cmd))))
+      (defalias fn-name (lambda (fn) (dotimes (i (if (integerp current-prefix-arg) current-prefix-arg 1)) (funcall fn))))
+      (advice-add cmd :around fn-name)))
+
+  ;; Custom commands to execute with `evil-mc'
+  (setq evil-mc-custom-known-commands
+        '((backward-kill-word (:default . evil-mc-execute-default-call-with-count))
+          (evil-delete-back-to-indentation (:default . evil-mc-execute-default-call))
+          (undo-fu-only-redo (:default . evil-mc-execute-default-redo))
+          (undo-fu-only-undo (:default . evil-mc-execute-default-undo))
+          (corfu-complete (:default . evil-mc-execute-default-complete))
+          (evil-numbers/dec-at-pt-incremental (:default . evil-mc-execute-default-call-with-count))
+          (evil-numbers/inc-at-pt-incremental (:default . evil-mc-execute-default-call-with-count))
+          (evil-org-delete (:default . evil-mc-execute-default-evil-delete))
+          (ess-smart-comma (:default . evil-mc-execute-call))
+          (evil-digit-argument-or-evil-beginning-of-visual-line
+           (:default . evil-mc-execute-default-call)
+           (visual . evil-mc-execute-visual-call)))))
+
+
+
+;;; For `me-org'
+
+(use-package evil-org
+  :straight t
+  :hook (org-mode . evil-org-mode))
+
+(use-package evil-org-agenda
+  :after evil-org
+  :demand
+  :config
+  (evil-org-agenda-set-keys))
+
+
+
+;;; For `me-builtin'
+
+(+evil-conf-for! org me-builtin
+  :config-form
+  (progn
+    ;; RET follows link (Evil equivalent for `org-return-follows-link')
+    (+nmap! :keymaps 'org-mode-map "RET" #'org-open-at-point)
+    (with-eval-after-load 'evil
+      ;; Fix `evil' search problem (to be used with `evil-search')
+      (when (eq evil-search-module 'evil-search)
+        (setq org-fold-core-style 'overlays)))))
+
+(+evil-conf-for! reftex me-builtin
+  :config-form
+  (with-eval-after-load 'evil
+    (add-hook 'reftex-mode-hook #'evil-normalize-keymaps)))
+
+
+
+;;; For `me-completion'
+
+(+evil-conf-for! corfu me-completion
+  :config-form
+  (progn
+    (keymap-set corfu-map "C-j" #'corfu-next)
+    (keymap-set corfu-map "C-k" #'corfu-previous)))
+
+(+evil-conf-for! vertico me-completion
+  :config-form
+  (progn
+    (keymap-set vertico-map "C-j" #'vertico-next)
+    (keymap-set vertico-map "C-k" #'vertico-previous)))
+
+
+
+;;; For `me-natural-langs'
+
+(when (memq 'me-natural-langs minemacs-modules)
+  (+nvmap! "z=" #'+spellcheck-correct))
+
+
+
+;;; For `me-editor'
+
+(when (memq 'me-editor minemacs-modules)
+  ;; Bind `+yank-region-as-paragraph' (autoloaded from "me-lib.el")
+  (+nvmap! "gy" #'+kill-region-as-paragraph))
+
+
+
+;;; For `me-tools'
+
+(+evil-conf-for! vterm me-tools
+  :config-form
+  (+imap! :keymaps 'vterm-mode-map
+    "C-l" #'vterm-send-right
+    "C-h" #'vterm-send-left
+    "C-k" #'vterm-send-up
+    "C-j" #'vterm-send-down))
+
+(+evil-conf-for! multi-vterm me-tools
+  :config-form
+  (+nvmap!
+    :keymaps 'vterm-mode-map
+    ",c" #'multi-vterm
+    ",n" #'multi-vterm-next
+    ",p" #'multi-vterm-prev
+    "<return>" #'evil-insert-resume))
+
+
+
+;;; For `me-editor'
+
+(+evil-conf-for! expreg me-prog
+  :init-form
+  (+vmap!
+    "v" #'expreg-expand
+    "q" #'expreg-contract))
+
+
+
+;;; For `me-files'
+
+(+evil-conf-for! dirvish me-files
+  :config-form
+  (+nvmap! :keymaps 'dirvish-mode-map
+    "q" #'dirvish-quit
+    "s" #'dirvish-subtree-toggle
+    "y" #'dirvish-yank-menu))
+
+
+
+;;; For `me-email'
+
+(+evil-conf-for! mu4e me-email
+  :config-form
+  (progn
+    (+nvmap! :keymaps 'mu4e-view-mode-map "p" #'mu4e-view-save-attachments)
+    (+nvmap! :keymaps '(mu4e-headers-mode-map mu4e-view-mode-map)
+      "gw" #'+mu4e-open-mail-as-html
+      "g RET" #'browse-url-at-point)))
+
+(+evil-conf-for! org-msg me-email
+  :config-form
+  (+nvmap! :keymaps 'org-msg-edit-mode-map "gg" #'org-msg-goto-body))
+
+
+
+;;; For `me-docs'
+
+(+evil-conf-for! nov me-docs
+  :config-form
+  (+nmap! :keymaps 'nov-mode-map "RET" #'nov-scroll-up))
+
+
+
+;;; For `me-docs'
+
+(+evil-conf-for! elfeed me-rss
+  :config-form
+  (progn
+    (+nmap! :keymaps 'elfeed-search-mode-map "d" #'+elfeed-youtube-dl)
+    (+nmap! :keymaps 'elfeed-show-mode-map "D" #'+elfeed-download-image)))
+
+
+
+;;; For `me-org'
+
+(+evil-conf-for! xkcd me-fun
+  :config-form
+  (+nvmap! :keymaps 'xkcd-mode-map
+    "j" #'xkcd-next
+    "k" #'xkcd-prev
+    "l" #'xkcd-get-latest
+    "L" #'xkcd-get-latest-cached
+    "<right>" #'xkcd-next
+    "<left>" #'xkcd-prev
+    "o" #'xkcd-open-browser
+    "O" #'xkcd-open-explanation-browser
+    "r" #'xkcd-rand
+    "y" #'xkcd-copy-link))
+
+
+
+;;; For `me-vc'
+
+(+evil-conf-for! git-commit me-vc
+  :config-form
+  (with-eval-after-load 'evil (evil-set-initial-state 'git-commit-mode 'insert)))
+
+
+
+;;; For `me-vc'
+
+(+evil-conf-for! diffview me-vc
+  :config-form
+  (+nvmap! :keymaps 'diffview--mode-map
+    "="   #'diffview--align-windows
+    "+"   #'diffview--align-windows
+    "C-j" #'diffview--next-file
+    "C-k" #'diffview--prev-file
+    "q"   #'diffview--quit))
+
+
+
+;;; For `me-ui'
+
+(+evil-conf-for! pulsar me-ui
+  :config-form
+  (with-eval-after-load 'evil
+    (cl-callf append pulsar-pulse-functions
+      '(evil-yank evil-paste-after evil-paste-before
+        evil-delete evil-delete-line evil-delete-whole-line
+        evil-goto-last-change evil-goto-last-change-reverse))))
+
 
 (provide 'me-evil)
 

modules/me-docs.el

@@ -40,10 +40,7 @@
   :straight t
   :mode ("\\.[eE][pP][uU][bB]\\'" . nov-mode)
   :custom
-  (nov-save-place-file (concat minemacs-local-dir "nov/save-place.el"))
-  :config
-  (+nmap! :keymaps 'nov-mode-map
-    "RET" #'nov-scroll-up))
+  (nov-save-place-file (concat minemacs-local-dir "nov/save-place.el")))
 
 (defconst +tuntox-available-p (and (executable-find "tuntox") t))
 (defconst +stunnel-available-p (and (executable-find "stunnel") t))

modules/me-editor.el

@@ -12,9 +12,8 @@
   :straight t
   :custom
   (tempel-trigger-prefix "<") ;; Require trigger prefix before template name when completing.
-  (tempel-path
-   (list (concat minemacs-assets-dir "templates/tempel/*.eld")
-         (concat minemacs-config-dir "templates/tempel/*.eld")))
+  (tempel-path (list (concat minemacs-assets-dir "templates/tempel/*.eld")
+                     (concat minemacs-config-dir "templates/tempel/*.eld")))
   :bind (("M-\"" . tempel-complete) ;; Alternative tempel-expand
          ("M-*" . tempel-insert)
          :map tempel-map
@@ -69,11 +68,7 @@
 
 (use-package expreg
   :straight (:host github :repo "casouri/expreg")
-  :when (+emacs-features-p 'tree-sitter)
-  :init
-  (+vmap!
-    "v" #'expreg-expand
-    "q" #'expreg-contract))
+  :when (+emacs-features-p 'tree-sitter))
 
 ;; Fallback to `expand-region' if `expreg' cannot be used
 (unless (+emacs-features-p 'tree-sitter)
@@ -117,9 +112,6 @@
   :straight t
   :bind (:package isearch :map isearch-mode-map ([f2] . cc-isearch-menu-transient)))
 
-;; Bind `+yank-region-as-paragraph' (autoloaded from "me-lib.el")
-(+nvmap! "gy" #'+kill-region-as-paragraph)
-
 
 (provide 'me-editor)
 

modules/me-email.el

@@ -65,11 +65,6 @@
   (mail-specify-envelope-from t)
   (mail-user-agent 'mu4e-user-agent)
   :config
-  (+nvmap! :keymaps 'mu4e-view-mode-map
-    "p" #'mu4e-view-save-attachments)
-  (+nvmap! :keymaps '(mu4e-headers-mode-map mu4e-view-mode-map)
-    "gw" #'+mu4e-open-mail-as-html
-    "g RET" #'browse-url-at-point)
   (+map-local! :keymaps '(mu4e-compose-mode-map org-msg-edit-mode-map)
     "s" #'message-send-and-exit
     "d" #'message-kill-buffer
@@ -166,8 +161,6 @@
            (seq (or (seq "pi" (any ?è ?e) "ce") "fichier" "document") (? "s") (+ (or " " eol)) "joint" (? "e") (? "s")) ;; pièce jointe
            (seq (or (seq space "p" (zero-or-one (any ?- ?.)) "j" (any space ?: ?\; ?, ?.))))))) ;; p.j
   :config
-  (+nvmap! :keymaps 'org-msg-edit-mode-map
-    "gg" #'org-msg-goto-body)
   (+map-local! :keymaps 'org-msg-edit-mode-map
     "a"  '(nil :wk "attach")
     "aa" #'org-msg-attach-attach