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