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