1 #+TITLE:Emacs Evil Config
3 #+EMAIL: seudut@gmail.com
5 As the =Evil= mode is significant, and has lots of configurations, it's better put them
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
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)
27 (use-package evil-leader
31 (evil-leader/set-leader ";")
32 (global-evil-leader-mode))
33 ;; (require 'evil-leader)
36 (add-hook 'prog-mode-hook #'(lambda ()
37 (modify-syntax-entry ?_ "w")
38 ;; (modify-syntax-entry ?- "w")
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)
49 (setq evil-move-cursor-back org)))))
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
59 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
60 (defvar my-mode-list-to-use-emacs-as-insert '(emacs-lisp-mode
63 lisp-interaction-mode)
64 "The mode in this list will consider insert state as emacs state by adding `advice-add' below.")
66 (defvar my-modes-use-emacs-init '(emacs-lisp-mode
73 "The mode in this list will use emacs sate as a initial evil state.")
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)))))
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
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))
102 [[https://github.com/redguardtoo/evil-matchit]]
103 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
104 (use-package evil-matchit
107 (global-evil-matchit-mode 1))
111 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
112 (use-package evil-visualstar
115 (setq evil-visualstar/persistent t)
117 (global-evil-visualstar-mode))
121 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
122 (use-package evil-surround
125 (global-evil-surround-mode 1))
131 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
132 (with-eval-after-load "evil-leader"
133 ;; Buffer & File explore
134 ;; (with-eval-after-load "ivy")
135 ;; (with-eval-after-load "counsel")
136 ;; (when (require 'ivy))
137 (evil-leader/set-key "b" 'counsel-projectile-find-file)
138 (evil-leader/set-key "f" 'ivy-switch-buffer)
139 (evil-leader/set-key "r" 'ivy-recentf)
141 ;; (evil-leader/set-key "o" 'ido-find-file)
142 ;; (evil-leader/set-key "t" 'projectile-find-file)
143 ;; (evil-leader/set-key "w" 'evil-save)
144 (evil-leader/set-key "w" 'save-buffer)
146 (evil-leader/set-key "s" 'evil-window-split)
147 (evil-leader/set-key "v" 'evil-window-vsplit)
148 (evil-leader/set-key "q" 'evil-quit)
150 (evil-leader/set-key "g" 'magit-status)
151 ;; (evil-leader/set-key "d" (lambda () (interactive) (dired default-directory)))
152 (evil-leader/set-key "d" 'dired)
153 (evil-leader/set-key "e" 'sd/toggle-project-eshell)
154 (evil-leader/set-key "h" 'help))
156 ** Basic state bindings
157 There are three kinds key bindings
158 - prefix key is the leader key, defined by evil-leader.
159 - prefix key is the =Ctrl=,
162 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
163 (with-eval-after-load "evil"
165 (define-key map "\C-W s" 'evil-window-split)
166 (define-key map "\C-W v" 'evil-window-vsplit)
167 (define-key map "\C-h" 'evil-window-left)
168 (define-key map "\C-j" 'evil-window-down)
169 (define-key map "\C-k" 'evil-window-up)
170 (define-key map "\C-l" 'evil-window-right)
171 (define-key map (kbd "C->") (lambda () (interactive) (evil-window-increase-width 3)))
172 (define-key map (kbd "C-<") (lambda () (interactive) (evil-window-decrease-width 3)))
173 (define-key map (kbd "C-+") (lambda () (interactive) (evil-window-increase-height 3)))
174 (define-key map (kbd "C--") (lambda () (interactive) (evil-window-decrease-height 3)))
175 (define-key map (kbd "C-=") (lambda () (interactive) (balance-windows))))
176 (list evil-normal-state-map evil-motion-state-map))
178 (define-key evil-normal-state-map (kbd "C-SPC") 'mode-line-other-buffer)
179 (define-key evil-normal-state-map (kbd "C-;") 'previous-multiframe-window)
181 (define-key evil-insert-state-map (kbd "C-p") 'previous-line)
182 (define-key evil-insert-state-map (kbd "C-n") 'next-line)
183 (define-key evil-insert-state-map (kbd "C-h") 'delete-backward-char)
184 (define-key evil-insert-state-map (kbd "C-a") 'move-beginning-of-line)
185 (define-key evil-insert-state-map (kbd "C-e") 'move-end-of-line)
186 (define-key evil-insert-state-map (kbd "C-k") 'kill-line)
188 (define-key evil-motion-state-map (kbd "SPC") 'scroll-up-command)
189 (define-key evil-motion-state-map (kbd "S-SPC") 'scroll-down-command))
193 Let the search highlight persistent, https://stackoverflow.com/questions/25768036/emacs-evil-non-incremental-search-and-persistent-highlighting/34252236
194 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
195 (evil-select-search-module 'evil-search-module 'evil-search)
197 (with-eval-after-load "evil"
198 (define-key evil-normal-state-map "\\" nil)
199 (define-key evil-normal-state-map "\\\\" #'evil-ex-nohighlight))
203 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
204 (add-hook 'eshell-mode-hook (lambda ()
205 (when (and (boundp 'evil-mode) evil-mode)
206 (dolist (key-fun '(("f" . ivy-switch-buffer)
207 ("b" . counsel-projectile-find-file)
208 ("r" . counsel-recentf)
209 ("e" . sd/toggle-project-eshell)
213 (evil-define-key 'emacs eshell-mode-map (kbd (concat evil-leader/leader (car key-fun))) (cdr key-fun))))
214 ;; (define-key eshell-mode-map (kbd "C-j") nil)
218 ;; (add-hook 'eshell-mode-map
220 ;; (mapc (lambda (key-fun)
221 ;; (evil-define-key 'emacs eshell-mode-map (kbd (concat evil-leader/leader (car key-fun))) (cdr key-fun)))
222 ;; '(("e" . dired)))))
224 ;; (add-hook 'eshell-mode-hook (lambda ()
225 ;; (loop for (key . fun) in '(
226 ;; ("e" . sd/toggle-project-eshell))
227 ;; do (evil-define-key 'emacs eshell-mode-map (kbd (concat evil-leader/leader key)) fun))))
230 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
231 (with-eval-after-load "evil"
232 ;; file and directory explore
233 (define-key dired-mode-map (kbd "C-h") nil)
234 (define-key dired-mode-map (kbd "C-k") nil)
235 (evil-define-key 'normal dired-mode-map (kbd "H") 'dired-omit-mode)
236 (evil-define-key 'normal dired-mode-map (kbd "g") 'dired-goto-file)
237 (evil-define-key 'normal dired-mode-map (kbd "r") 'revert-buffer)
238 (evil-define-key 'normal dired-mode-map (kbd "i") 'dired-maybe-insert-subdir)
239 (evil-define-key 'normal dired-mode-map (kbd "TAB") 'diredp-next-subdir)
240 (evil-define-key 'normal dired-mode-map (kbd "J") 'diredp-next-subdir)
241 (evil-define-key 'normal dired-mode-map (kbd "K") 'diredp-prev-subdir)
242 (evil-define-key 'normal dired-mode-map (kbd "l") 'dired-display-file)
243 (evil-define-key 'normal dired-mode-map (kbd "f") 'dired-narrow)
244 (evil-define-key 'normal dired-mode-map (kbd "j") 'sd/dired-next-line)
245 (evil-define-key 'normal dired-mode-map (kbd "k") 'sd/dired-previous-line)
246 (evil-define-key 'normal dired-mode-map (kbd "h") 'sd/dired-up-directory)
247 (evil-define-key 'normal dired-mode-map [C-backspace] 'dired-up-directory)
248 ;; file and folder deletion
249 (evil-define-key 'normal dired-mode-map (kbd "m") 'dired-mark)
250 (evil-define-key 'normal dired-mode-map (kbd "u") 'dired-unmark)
251 (evil-define-key 'normal dired-mode-map (kbd "U") 'dired-unmark-all-marks)
252 (evil-define-key 'normal dired-mode-map (kbd "z") #'sd/dired-get-size)
253 (evil-define-key 'normal dired-mode-map (kbd "d") 'dired-flag-file-deletion)
254 (evil-define-key 'normal dired-mode-map (kbd "x") 'dired-do-flagged-delete)
255 (evil-define-key 'normal dired-mode-map (kbd "D") 'dired-do-delete)
256 ;; File and folder creation
257 (evil-define-key 'normal dired-mode-map (kbd "c") 'sd/dired-new-file)
258 (evil-define-key 'normal dired-mode-map (kbd "+") 'dired-create-directory)
259 (evil-define-key 'normal dired-mode-map (kbd "C") 'dired-do-copy)
260 (evil-define-key 'normal dired-mode-map (kbd "R") 'dired-do-rename)
262 ;; keep some normap mapping
263 (evil-define-key 'normal dired-mode-map (kbd "/") 'evil-ex-search-forward)
264 (evil-define-key 'normal dired-mode-map (kbd "n") 'evil-search-next)
265 (evil-define-key 'normal dired-mode-map (kbd "N") 'evil-search-previous)
266 (evil-define-key 'normal dired-mode-map (kbd "v") 'evil-visual-char))
271 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
272 (with-eval-after-load "evil"
273 (with-eval-after-load "expand-region"
274 (define-key evil-normal-state-map (kbd "SPC") 'er/expand-region)
275 (define-key evil-visual-state-map (kbd "SPC") 'er/expand-region)
276 (define-key evil-visual-state-map (kbd "S-SPC") 'er/contract-region)
277 (define-key evil-normal-state-map (kbd "S-SPC") 'er/contract-region)))
280 ** Org Mode (worf mode) and Lispy mode
281 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
282 (with-eval-after-load "evil"
283 (with-eval-after-load "lispy"
284 (evil-define-key 'normal lispy-mode-map (kbd "[") (lambda ()
286 (call-interactively #'lispy-backward)
288 (evil-define-key 'normal lispy-mode-map (kbd "]") (lambda ()
290 (call-interactively #'lispy-forward)
291 (evil-emacs-state))))
292 (with-eval-after-load "worf"
293 (evil-define-key 'normal worf-mode-map (kbd "[") (lambda ()
295 (call-interactively #'worf-backward)
297 (evil-define-key 'normal worf-mode-map (kbd "]") (lambda ()
299 (call-interactively #'worf-forward)
300 (evil-emacs-state)))))
304 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
305 (dolist (mode '(c-mode-hook lua-mode-hook))
306 (add-hook mode (lambda () (setq indent-tabs-mode nil))))
309 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
310 (provide 'init-evil-mode)