emacs.d/emacs-evil.org

   1 #+TITLE:Emacs Evil Config
   2 #+AUTHOR: Peng Li
   3 #+EMAIL: seudut@gmail.com
   4
   5 As the =Evil= mode is significant, and has lots of configurations, it's better put them
   6 in a separate file.
   7
   8 * Evil mode
   9 ** Install and basic config
  10 https://www.emacswiki.org/emacs/Evil.
  11 =global-evil-leader-mode= should be set before =evil-mode=.
  12 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
  13   (use-package evil
  14     :ensure t
  15     :init
  16     ;; (setq evil-default-state 'emacs)
  17     (setq evil-emacs-state-cursor '("red" box))
  18     (setq evil-normal-state-cursor '("green" box))
  19     (setq evil-motion-state-cursor '("green" box))
  20     (setq evil-visual-state-cursor '("orange" box))
  21     (setq evil-insert-state-cursor '("red" bar))
  22     (setq evil-replace-state-cursor '("red" bar))
  23     (setq evil-operator-state-cursor '("red" hollow))
  24     ;; others, don't move back cursor when exit insert mode
  25     (setq evil-move-cursor-back nil)
  26     :config
  27     (use-package evil-leader
  28       :ensure t
  29       :init
  30       :config
  31       (evil-leader/set-leader ";")
  32       (global-evil-leader-mode))
  33     ;; (require 'evil-leader)
  34     (evil-mode t))
  35
  36   (add-hook 'prog-mode-hook #'(lambda ()
  37                                 (modify-syntax-entry ?_ "w")
  38                                 ;; (modify-syntax-entry ?- "w")
  39                                 ))
  40
  41   (with-eval-after-load "evil"
  42     ;; remap x to X as `evil-move-cursor-back' is set nil
  43     ;; (define-key evil-normal-state-map [remap evil-delete-char] 'evil-delete-backward-char)
  44     (define-key evil-normal-state-map (kbd "x") (lambda () (interactive)
  45                                                   (let ((org evil-move-cursor-back))
  46                                                     (setq evil-move-cursor-back t)
  47                                                     (call-interactively 'evil-delete-char)
  48                                                     ;; (evil-delete-char)
  49                                                     (setq evil-move-cursor-back org)))))
  50 #+END_SRC
  51
  52 ** Initial mode and state config
  53 - Use =normal= as the default state but exclude some special modes.
  54 - Bind =[escape]=  to =normal= mode. This only works on GUI Emacs. If need to work on Terminal, shoudl also bind =(kbd
  55   "<ESC>)=, but this will make the combined key =M-= not wor.
  56 - Not alias =insert= state to =emacs= state, as it break some vi's feature in insert mode, such as column edit. Instead,
  57   here add a advice function to change the sate as emacs when enter insert mode, but this is only limited in some
  58   certain modes.
  59 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
  60   (defvar my-mode-list-to-use-emacs-as-insert '(emacs-lisp-mode
  61                                                 org-mode
  62                                                 eshell-mode
  63                                                 lisp-interaction-mode)
  64     "The mode in this list will consider insert state as emacs state by adding `advice-add' below.")
  65
  66   (defvar my-modes-use-emacs-init '(emacs-lisp-mode
  67                                     org-mode
  68                                     lisp-interaction-mode
  69                                     eshell-mode
  70                                     text-mode
  71                                     package-menu-mode
  72                                     paradox-menu-mode)
  73     "The mode in this list will use emacs sate as a initial evil state.")
  74
  75   (with-eval-after-load "evil"
  76     (setq evil-default-state 'normal)
  77       ;; (defalias 'evil-inset-mode 'evil-emacs-state)
  78     (define-key evil-emacs-state-map [escape] 'evil-normal-state)
  79     ;; (define-key evil-emacs-state-map (kbd "<ESC>") 'evil-normal-state)
  80     (dolist (mode my-modes-use-emacs-init) (evil-set-initial-state mode 'emacs))
  81     (advice-add 'evil-insert-state :after (lambda (&optional arg)
  82                                             (when (memq major-mode my-mode-list-to-use-emacs-as-insert)
  83                                               (evil-emacs-state)))))
  84 #+END_SRC
  85
  86 * Evil-escape
  87 [[https://github.com/syl20bnr/evil-escape][evil-escape]], escape from anything with customizable key sequence.
  88 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
  89   (use-package evil-escape
  90     :ensure t
  91     :init
  92     (setq-default evil-escape-delay 0.2)
  93     (setq-default evil-escape-key-sequence "jj")
  94     (setq-default evil-escape-excluded-states '(normal visual motion emacs))
  95     (setq-default evil-escape-excluded-major-modes '(emacs-lisp-mode org-mode))
  96     :config
  97     (evil-escape-mode))
  98 #+END_SRC
  99
 100 * Evil-Leader
 101 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 102   (with-eval-after-load "evil-leader"
 103     ;; Buffer & File
 104     (evil-leader/set-key "f" 'ido-switch-buffer)
 105     (evil-leader/set-key "w" 'evil-save)
 106     (evil-leader/set-key "r" 'ivy-recentf)
 107     (evil-leader/set-key "w" 'save-buffer)
 108     (evil-leader/set-key "o" 'ido-find-file)
 109     (evil-leader/set-key "p" 'projectile-find-file)
 110     ;; Window
 111     (evil-leader/set-key "s" 'evil-window-split)
 112     (evil-leader/set-key "v" 'evil-window-vsplit)
 113     (evil-leader/set-key "q" 'evil-quit)
 114     ;; others
 115     (evil-leader/set-key "h" 'help)
 116     (evil-leader/set-key "g" 'magit-status)
 117     (evil-leader/set-key "d" 'dired)
 118     (evil-leader/set-key "e" 'sd/toggle-project-eshell))
 119
 120
 121 #+END_SRC
 122
 123 * other extention
 124 ** Evil-matchit
 125 [[https://github.com/redguardtoo/evil-matchit]]
 126 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 127   (use-package evil-matchit
 128     :ensure t
 129     :config
 130     (global-evil-matchit-mode 1))
 131 #+END_SRC
 132
 133 ** Evil-visualstar
 134 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 135   (use-package evil-visualstar
 136     :ensure t
 137     :init
 138     (setq evil-visualstar/persistent t)
 139     :config
 140     (global-evil-visualstar-mode))
 141 #+END_SRC
 142
 143 ** Evil-surround
 144 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 145   (use-package evil-surround
 146     :ensure t
 147     :config
 148     (global-evil-surround-mode 1))
 149 #+END_SRC
 150 * Key bindings
 151 ** Basic state bindings
 152 There are three kinds key bindings
 153 - prefix key is the leader key, defined by evil-leader. *;*
 154 - prefix key is the =Ctrl=,
 155 - prefix key is =\=,
 156
 157 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 158   (with-eval-after-load "evil"
 159     (mapc (lambda (map)
 160             (define-key map "\C-W s" 'evil-window-split)
 161             (define-key map "\C-W v" 'evil-window-vsplit)
 162             (define-key map "\C-h" 'evil-window-left)
 163             (define-key map "\C-j" 'evil-window-down)
 164             (define-key map "\C-k" 'evil-window-up)
 165             (define-key map "\C-l" 'evil-window-right)
 166             (define-key map (kbd "C->") (lambda () (interactive) (evil-window-increase-width 3)))
 167             (define-key map (kbd "C-<") (lambda () (interactive) (evil-window-decrease-width 3)))
 168             (define-key map (kbd "C-+") (lambda () (interactive) (evil-window-increase-height 3)))
 169             (define-key map (kbd "C--") (lambda () (interactive) (evil-window-decrease-height 3)))
 170             (define-key map (kbd "C-=") (lambda () (interactive) (balance-windows))))
 171           (list evil-normal-state-map evil-motion-state-map))
 172     ;; normal state
 173     (define-key evil-normal-state-map (kbd "C-SPC") 'mode-line-other-buffer)
 174     (define-key evil-normal-state-map (kbd "C-;") 'previous-multiframe-window)
 175     ;; insert state
 176     (define-key evil-insert-state-map (kbd "C-p") 'previous-line)
 177     (define-key evil-insert-state-map (kbd "C-n") 'next-line)
 178     (define-key evil-insert-state-map (kbd "C-h") 'delete-backward-char)
 179     (define-key evil-insert-state-map (kbd "C-a") 'move-beginning-of-line)
 180     (define-key evil-insert-state-map (kbd "C-e") 'move-end-of-line)
 181     (define-key evil-insert-state-map (kbd "C-k") 'kill-line)
 182     ;; motion mode
 183     (define-key evil-motion-state-map (kbd "SPC") 'scroll-up-command)
 184     (define-key evil-motion-state-map (kbd "S-SPC") 'scroll-down-command))
 185 #+END_SRC
 186
 187
 188 Let the search highlight persistent, https://stackoverflow.com/questions/25768036/emacs-evil-non-incremental-search-and-persistent-highlighting/34252236
 189 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 190   (evil-select-search-module 'evil-search-module 'evil-search)
 191
 192   (with-eval-after-load "evil"
 193     (define-key evil-normal-state-map "\\" nil)
 194     (define-key evil-normal-state-map "\\\\" #'evil-ex-nohighlight))
 195 #+END_SRC
 196
 197 ** Eshell
 198 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 199   (with-eval-after-load "evil"
 200     (with-eval-after-load "evil-leader"
 201       (with-eval-after-load "eshell"
 202         (evil-define-key 'emacs eshell-mode-map (kbd (concat evil-leader/leader "e")) #'sd/toggle-project-eshell)
 203         (evil-define-key 'emacs eshell-mode-map (kbd (concat evil-leader/leader "d")) #'dired)
 204         (evil-define-key 'emacs eshell-mode-map (kbd (concat evil-leader/leader "f")) #'ido-switch-buffer)
 205         (evil-define-key 'emacs eshell-mode-map (kbd (concat evil-leader/leader "q")) #'evil-quit)
 206         (evil-define-key 'emacs eshell-mode-map (kbd "C-;") 'mode-line-other-buffer)
 207         ;; (evil-define-key 'emacs eshell-mode-map (kbd ";q") 'evil-quit)
 208         )))
 209
 210 #+END_SRC
 211 ** Dired mode
 212 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 213   (with-eval-after-load "evil"
 214     ;; file and directory explore
 215     (define-key dired-mode-map (kbd "C-h") nil)
 216     (define-key dired-mode-map (kbd "C-k") nil)
 217     (evil-define-key 'normal dired-mode-map (kbd "H") 'dired-omit-mode)
 218     (evil-define-key 'normal dired-mode-map (kbd "g") 'dired-goto-file)
 219     (evil-define-key 'normal dired-mode-map (kbd "r") 'revert-buffer)
 220     (evil-define-key 'normal dired-mode-map (kbd "i") 'dired-maybe-insert-subdir)
 221     (evil-define-key 'normal dired-mode-map (kbd "TAB") 'diredp-next-subdir)
 222     (evil-define-key 'normal dired-mode-map (kbd "J") 'diredp-next-subdir)
 223     (evil-define-key 'normal dired-mode-map (kbd "K") 'diredp-prev-subdir)
 224     (evil-define-key 'normal dired-mode-map (kbd "l") 'dired-display-file)
 225     (evil-define-key 'normal dired-mode-map (kbd "f") 'dired-narrow)
 226     (evil-define-key 'normal dired-mode-map (kbd "j") 'sd/dired-next-line)
 227     (evil-define-key 'normal dired-mode-map (kbd "k") 'sd/dired-previous-line)
 228     (evil-define-key 'normal dired-mode-map (kbd "h") 'sd/dired-up-directory)
 229     (evil-define-key 'normal dired-mode-map [C-backspace] 'dired-up-directory)
 230     ;; file and folder deletion
 231     (evil-define-key 'normal dired-mode-map (kbd "m") 'dired-mark)
 232     (evil-define-key 'normal dired-mode-map (kbd "u") 'dired-unmark)
 233     (evil-define-key 'normal dired-mode-map (kbd "U") 'dired-unmark-all-marks)
 234     (evil-define-key 'normal dired-mode-map (kbd "z") #'sd/dired-get-size)
 235     (evil-define-key 'normal dired-mode-map (kbd "d") 'dired-flag-file-deletion)
 236     (evil-define-key 'normal dired-mode-map (kbd "x") 'dired-do-flagged-delete)
 237     (evil-define-key 'normal dired-mode-map (kbd "D") 'dired-do-delete)
 238     ;; File and folder creation
 239     (evil-define-key 'normal dired-mode-map (kbd "c") 'sd/dired-new-file)
 240     (evil-define-key 'normal dired-mode-map (kbd "+") 'dired-create-directory)
 241     (evil-define-key 'normal dired-mode-map (kbd "C") 'dired-do-copy)
 242     (evil-define-key 'normal dired-mode-map (kbd "R") 'dired-do-rename)
 243
 244     ;; keep some normap mapping
 245     (evil-define-key 'normal dired-mode-map (kbd "/") 'evil-ex-search-forward)
 246     (evil-define-key 'normal dired-mode-map (kbd "n") 'evil-search-next)
 247     (evil-define-key 'normal dired-mode-map (kbd "N") 'evil-search-previous)
 248     (evil-define-key 'normal dired-mode-map (kbd "v") 'evil-visual-char))
 249
 250 #+END_SRC
 251
 252 ** expand region
 253 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 254   (with-eval-after-load "evil"
 255     (with-eval-after-load "expand-region"
 256       (define-key evil-normal-state-map (kbd "SPC") 'er/expand-region)
 257       (define-key evil-visual-state-map (kbd "SPC") 'er/expand-region)
 258       (define-key evil-visual-state-map (kbd "S-SPC") 'er/contract-region)
 259       (define-key evil-normal-state-map (kbd "S-SPC") 'er/contract-region)))
 260 #+END_SRC
 261
 262 ** Org Mode (worf mode) and Lispy mode
 263 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 264   (with-eval-after-load "evil"
 265     (with-eval-after-load "lispy"
 266       (evil-define-key 'normal lispy-mode-map (kbd "[") (lambda ()
 267                                                           (interactive)
 268                                                           (call-interactively #'lispy-backward)
 269                                                           (evil-emacs-state)))
 270       (evil-define-key 'normal lispy-mode-map (kbd "]") (lambda ()
 271                                                           (interactive)
 272                                                           (call-interactively #'lispy-forward)
 273                                                           (evil-emacs-state))))
 274     (with-eval-after-load "worf"
 275       (evil-define-key 'normal worf-mode-map (kbd "[") (lambda ()
 276                                                          (interactive)
 277                                                          (call-interactively #'worf-backward)
 278                                                          (evil-emacs-state)))
 279       (evil-define-key 'normal worf-mode-map (kbd "]") (lambda ()
 280                                                          (interactive)
 281                                                          (call-interactively #'worf-forward)
 282                                                          (evil-emacs-state)))))
 283 #+END_SRC
 284
 285 * Others
 286 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 287   (dolist (mode '(c-mode-hook lua-mode-hook))
 288     (add-hook mode (lambda () (setq indent-tabs-mode nil))))
 289 #+END_SRC
 290 * Provide
 291 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 292   (provide 'init-evil-mode)
 293 #+END_SRC