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     :config
  25     (use-package evil-leader
  26       :ensure t
  27       :init
  28       :config
  29       (evil-leader/set-leader ";")
  30       (global-evil-leader-mode))
  31     ;; (require 'evil-leader)
  32     (evil-mode t))
  33 #+END_SRC
  34
  35 ** Initial mode and state config
  36 - Use =normal= as the default state but exclude some special modes.
  37 - Bind =[escape]=  to =normal= mode. This only works on GUI Emacs. If need to work on Terminal, shoudl also bind =(kbd
  38   "<ESC>)=, but this will make the combined key =M-= not wor.
  39 - Not alias =insert= state to =emacs= state, as it break some vi's feature in insert mode, such as column edit. Instead,
  40   here add a advice function to change the sate as emacs when enter insert mode, but this is only limited in some
  41   certain modes.
  42 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
  43   (defvar my-mode-list-to-use-emacs-as-insert '(emacs-lisp-mode
  44                                                 org-mode
  45                                                 eshell-mode
  46                                                 lisp-interaction-mode)
  47     "The mode in this list will consider insert state as emacs state by adding `advice-add' below.")
  48
  49   (defvar my-modes-use-emacs-init '(emacs-lisp-mode
  50                                     org-mode
  51                                     lisp-interaction-mode
  52                                     eshell-mode
  53                                     text-mode
  54                                     package-menu-mode
  55                                     paradox-menu-mode)
  56     "The mode in this list will use emacs sate as a initial evil state.")
  57
  58   (with-eval-after-load "evil"
  59     (setq evil-default-state 'normal)
  60       ;; (defalias 'evil-inset-mode 'evil-emacs-state)
  61     (define-key evil-emacs-state-map [escape] 'evil-normal-state)
  62     ;; (define-key evil-emacs-state-map (kbd "<ESC>") 'evil-normal-state)
  63     (dolist (mode my-modes-use-emacs-init) (evil-set-initial-state mode 'emacs))
  64     (advice-add 'evil-insert-state :after (lambda (&optional arg)
  65                                             (when (memq major-mode my-mode-list-to-use-emacs-as-insert)
  66                                               (evil-emacs-state)))))
  67 #+END_SRC
  68
  69
  70 * Evil-escape
  71 [[https://github.com/syl20bnr/evil-escape][evil-escape]], escape from anything with customizable key sequence.
  72 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
  73   (use-package evil-escape
  74     :ensure t
  75     :init
  76     (setq-default evil-escape-delay 0.2)
  77     (setq-default evil-escape-key-sequence "jj")
  78     (setq-default evil-escape-excluded-states '(normal visual motion emacs))
  79     (setq-default evil-escape-excluded-major-modes '(emacs-lisp-mode org-mode))
  80     :config
  81     (evil-escape-mode))
  82 #+END_SRC
  83
  84 * Evil-Leader
  85 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
  86   (with-eval-after-load "evil-leader"
  87     ;; Buffer & File
  88     (evil-leader/set-key "f" 'ido-switch-buffer)
  89     (evil-leader/set-key "w" 'evil-save)
  90     (evil-leader/set-key "r" 'ivy-recentf)
  91     (evil-leader/set-key "w" 'save-buffer)
  92     (evil-leader/set-key "o" 'ido-find-file)
  93     (evil-leader/set-key "p" 'projectile-find-file)
  94     ;; Window
  95     (evil-leader/set-key "s" 'evil-window-split)
  96     (evil-leader/set-key "v" 'evil-window-vsplit)
  97     (evil-leader/set-key "q" 'evil-quit)
  98     ;; others
  99     (evil-leader/set-key "h" 'help)
 100     (evil-leader/set-key "g" 'magit-status)
 101     (evil-leader/set-key "d" 'dired)
 102     (evil-leader/set-key "e" 'sd/toggle-project-eshell))
 103
 104   (with-eval-after-load "evil"
 105     (evil-define-key 'emacs eshell-mode-map (kbd ";e") 'sd/toggle-project-eshell)
 106     (evil-define-key 'emacs eshell-mode-map (kbd ";d") 'dired)
 107     (evil-define-key 'emacs eshell-mode-map (kbd "C-;") 'mode-line-other-buffer))
 108
 109 #+END_SRC
 110
 111 * other extention
 112 ** Evil-matchit
 113 [[https://github.com/redguardtoo/evil-matchit]]
 114 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 115   (use-package evil-matchit
 116     :ensure t
 117     :config
 118     (global-evil-matchit-mode 1))
 119 #+END_SRC
 120
 121 ** Evil-visualstar
 122 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 123   (use-package evil-visualstar
 124     :ensure t
 125     :init
 126     (setq evil-visualstar/persistent t)
 127     :config
 128     (global-evil-visualstar-mode))
 129 #+END_SRC
 130
 131 ** Evil-surround
 132 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 133   (use-package evil-surround
 134     :ensure t
 135     :config
 136     (global-evil-surround-mode 1))
 137 #+END_SRC
 138 * Key bindings
 139 There are three kinds key bindings
 140 - prefix key is the leader key, defined by evil-leader. *;*
 141 - prefix key is the =Ctrl=,
 142 - prefix key is =\=,
 143
 144 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 145   (with-eval-after-load "evil"
 146     (mapc (lambda (map)
 147             (define-key map "\C-W s" 'evil-window-split)
 148             (define-key map "\C-W v" 'evil-window-vsplit)
 149             (define-key map "\C-h" 'evil-window-left)
 150             (define-key map "\C-j" 'evil-window-down)
 151             (define-key map "\C-k" 'evil-window-up)
 152             (define-key map "\C-l" 'evil-window-right)
 153             (define-key map (kbd "C->") (lambda () (interactive) (evil-window-increase-width 3)))
 154             (define-key map (kbd "C-<") (lambda () (interactive) (evil-window-decrease-width 3)))
 155             (define-key map (kbd "C-+") (lambda () (interactive) (evil-window-increase-height 3)))
 156             (define-key map (kbd "C--") (lambda () (interactive) (evil-window-decrease-height 3)))
 157             (define-key map (kbd "C-=") (lambda () (interactive) (balance-windows))))
 158           (list evil-normal-state-map evil-motion-state-map))
 159     ;; normal state
 160     (define-key evil-normal-state-map (kbd "C-SPC") 'mode-line-other-buffer)
 161     (define-key evil-normal-state-map (kbd "C-;") 'previous-multiframe-window)
 162     ;; insert state
 163     (define-key evil-insert-state-map (kbd "C-p") 'previous-line)
 164     (define-key evil-insert-state-map (kbd "C-n") 'next-line)
 165     (define-key evil-insert-state-map (kbd "C-h") 'delete-backward-char)
 166     ;; motion mode
 167     (define-key evil-motion-state-map (kbd "SPC") 'scroll-up-command)
 168     (define-key evil-motion-state-map (kbd "S-SPC") 'scroll-down-command))
 169 #+END_SRC
 170
 171
 172 Let the search highlight persistent, https://stackoverflow.com/questions/25768036/emacs-evil-non-incremental-search-and-persistent-highlighting/34252236
 173 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 174   (evil-select-search-module 'evil-search-module 'evil-search)
 175
 176   (with-eval-after-load "evil"
 177     (define-key evil-normal-state-map "\\" nil)
 178     (define-key evil-normal-state-map "\\\\" #'evil-ex-nohighlight))
 179 #+END_SRC
 180
 181 - Dired mode
 182 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 183   (with-eval-after-load "evil"
 184     ;; file and directory explore
 185     (evil-define-key 'normal dired-mode-map (kbd "H") 'dired-omit-mode)
 186     (evil-define-key 'normal dired-mode-map (kbd "g") 'dired-goto-file)
 187     (evil-define-key 'normal dired-mode-map (kbd "r") 'revert-buffer)
 188     (evil-define-key 'normal dired-mode-map (kbd "i") 'dired-maybe-insert-subdir)
 189     (evil-define-key 'normal dired-mode-map (kbd "TAB") 'diredp-next-subdir)
 190     (evil-define-key 'normal dired-mode-map (kbd "J") 'diredp-next-subdir)
 191     (evil-define-key 'normal dired-mode-map (kbd "K") 'diredp-prev-subdir)
 192     (evil-define-key 'normal dired-mode-map (kbd "l") 'dired-display-file)
 193     (evil-define-key 'normal dired-mode-map (kbd "f") 'dired-narrow)
 194     (evil-define-key 'normal dired-mode-map (kbd "j") 'dired-next-line)
 195     (evil-define-key 'normal dired-mode-map (kbd "k") 'dired-previous-line)
 196     (evil-define-key 'normal dired-mode-map [C-backspace] 'dired-up-directory)
 197     ;; file and folder deletion
 198     (evil-define-key 'normal dired-mode-map (kbd "m") 'dired-mark)
 199     (evil-define-key 'normal dired-mode-map (kbd "u") 'dired-unmark)
 200     (evil-define-key 'normal dired-mode-map (kbd "U") 'dired-unmark-all-marks)
 201     (evil-define-key 'normal dired-mode-map (kbd "z") #'sd/dired-get-size)
 202     (evil-define-key 'normal dired-mode-map (kbd "d") 'dired-flag-file-deletion)
 203     (evil-define-key 'normal dired-mode-map (kbd "x") 'dired-do-flagged-delete)
 204     (evil-define-key 'normal dired-mode-map (kbd "D") 'dired-do-delete)
 205     ;; File and folder creation
 206     (evil-define-key 'normal dired-mode-map (kbd "c") 'sd/dired-new-file)
 207     (evil-define-key 'normal dired-mode-map (kbd "C") 'dired-create-directory)
 208
 209     ;; keep some normap mapping
 210     (evil-define-key 'normal dired-mode-map (kbd "/") 'evil-ex-search-forward)
 211     (evil-define-key 'normal dired-mode-map (kbd "n") 'evil-search-next)
 212     (evil-define-key 'normal dired-mode-map (kbd "N") 'evil-search-previous)
 213     (evil-define-key 'normal dired-mode-map (kbd "v") 'evil-visual-char))
 214
 215 #+END_SRC
 216
 217 - expand region
 218 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 219   (with-eval-after-load "evil"
 220     (with-eval-after-load "expand-region"
 221       (define-key evil-normal-state-map (kbd "SPC") 'er/expand-region)
 222       (define-key evil-visual-state-map (kbd "SPC") 'er/expand-region)
 223       (define-key evil-visual-state-map (kbd "S-SPC") 'er/contract-region)
 224       (define-key evil-normal-state-map (kbd "S-SPC") 'er/contract-region)))
 225 #+END_SRC
 226
 227 * Others
 228 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 229   (dolist (mode '(c-mode-hook lua-mode-hook))
 230     (add-hook mode (lambda () (setq indent-tabs-mode nil))))
 231 #+END_SRC
 232 * Provide
 233 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 234   (provide 'init-evil-mode)
 235 #+END_SRC