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")
42 ** Initial mode and state config
43 - Use =normal= as the default state but exclude some special modes.
44 - Bind =[escape]= to =normal= mode. This only works on GUI Emacs. If need to work on Terminal, shoudl also bind =(kbd
45 "<ESC>)=, but this will make the combined key =M-= not wor.
46 - Not alias =insert= state to =emacs= state, as it break some vi's feature in insert mode, such as column edit. Instead,
47 here add a advice function to change the sate as emacs when enter insert mode, but this is only limited in some
49 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
50 (defvar my-mode-list-to-use-emacs-as-insert '(emacs-lisp-mode
53 lisp-interaction-mode)
54 "The mode in this list will consider insert state as emacs state by adding `advice-add' below.")
56 (defvar my-modes-use-emacs-init '(emacs-lisp-mode
63 "The mode in this list will use emacs sate as a initial evil state.")
65 (with-eval-after-load "evil"
66 (setq evil-default-state 'normal)
67 ;; (defalias 'evil-inset-mode 'evil-emacs-state)
68 (define-key evil-emacs-state-map [escape] 'evil-normal-state)
69 ;; (define-key evil-emacs-state-map (kbd "<ESC>") 'evil-normal-state)
70 (dolist (mode my-modes-use-emacs-init) (evil-set-initial-state mode 'emacs))
71 (advice-add 'evil-insert-state :after (lambda (&optional arg)
72 (when (memq major-mode my-mode-list-to-use-emacs-as-insert)
73 (evil-emacs-state)))))
77 [[https://github.com/syl20bnr/evil-escape][evil-escape]], escape from anything with customizable key sequence.
78 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
79 (use-package evil-escape
82 (setq-default evil-escape-delay 0.2)
83 (setq-default evil-escape-key-sequence "jj")
84 (setq-default evil-escape-excluded-states '(normal visual motion emacs))
85 (setq-default evil-escape-excluded-major-modes '(emacs-lisp-mode org-mode))
92 [[https://github.com/redguardtoo/evil-matchit]]
93 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
94 (use-package evil-matchit
97 (global-evil-matchit-mode 1))
101 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
102 (use-package evil-visualstar
105 (setq evil-visualstar/persistent t)
107 (global-evil-visualstar-mode))
111 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
112 (use-package evil-surround
115 (global-evil-surround-mode 1))
119 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
120 (defun sd/swith-to-buffer ()
123 (if (projectile-project-p)
124 (projectile-switch-to-buffer)
125 (ivy-switch-buffer)))
129 '(("j" ivy--switch-buffer-other-window-action "other window")))
131 (with-eval-after-load "evil-leader"
132 (cl-loop for (key . fun ) in '(("F" . counsel-projectile-switch-to-buffer)
133 ("f" . sd/swith-to-buffer)
134 ("b" . counsel-projectile-find-file)
137 ("v" . evil-window-vsplit)
138 ("s" . evil-window-split)
139 ("t" . sd/hydra-gtags/body)
140 ("p" . sd/hydra-projectile/body)
143 ("e" . sd/toggle-project-eshell)
146 do (evil-leader/set-key key fun)))
148 ** Basic state bindings
149 There are three kinds key bindings
150 - prefix key is the leader key, defined by evil-leader.
151 - prefix key is the =Ctrl=,
154 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
155 (with-eval-after-load "evil"
157 (define-key map "\C-W s" 'evil-window-split)
158 (define-key map "\C-W v" 'evil-window-vsplit)
159 (define-key map "\C-h" 'evil-window-left)
160 (define-key map "\C-j" 'evil-window-down)
161 (define-key map "\C-k" 'evil-window-up)
162 (define-key map "\C-l" 'evil-window-right)
163 (define-key map (kbd "C->") (lambda () (interactive) (evil-window-increase-width 3)))
164 (define-key map (kbd "C-<") (lambda () (interactive) (evil-window-decrease-width 3)))
165 (define-key map (kbd "C-+") (lambda () (interactive) (evil-window-increase-height 3)))
166 (define-key map (kbd "C--") (lambda () (interactive) (evil-window-decrease-height 3)))
167 (define-key map (kbd "C-=") (lambda () (interactive) (balance-windows)))
168 ;; As ; has been defined as leader, so remap , to ; repeaat t/f
169 (define-key map (kbd ",") 'evil-repeat-find-char))
170 (list evil-normal-state-map evil-motion-state-map))
173 (cl-loop for (key-sequence . fun) in '(("C-;" . iedit-mode)
175 ("C-p" . previous-line)
176 ("C-a" . move-beginning-of-line)
177 ("C-e" . move-end-of-line)
178 ("C-h" . delete-backward-char)
180 do (define-key evil-insert-state-map (kbd key-sequence) fun))
182 ;; remap some vim keybindings
184 evil-normal-state-map
185 evil-visual-state-map
186 evil-motion-state-map))
187 (cl-loop for (keys . fun) in '(("'" . evil-goto-mark)
188 ("`" . evil-goto-mark-line))
189 do (define-key map (kbd keys) fun)))
194 ;; (define-key evil-motion-state-map (kbd "SPC") 'scroll-up-command)
195 ;; (define-key evil-motion-state-map (kbd "S-SPC") 'scroll-down-command)
199 ;; (keymapp (car (list evil-normal-state-map evil-visual-state-map)))
201 ;; (keymapp (car '(evil-normal-state-map evil-visual-state-map)))
202 ;; (keymapp (car `(,evil-normal-state-map ,evil-visual-state-map)))
205 ;; (keymapp evil-normal-state-map)
206 ;; (keymapp 'evil-normal-state-map)
207 ;; (keymapp `,evil-normal-state-map)
211 Let the search highlight persistent, https://stackoverflow.com/questions/25768036/emacs-evil-non-incremental-search-and-persistent-highlighting/34252236
212 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
213 (evil-select-search-module 'evil-search-module 'evil-search)
215 (with-eval-after-load "evil"
216 (define-key evil-normal-state-map "\\" nil)
217 (define-key evil-normal-state-map "\\\\" #'evil-ex-nohighlight)
218 (define-key evil-normal-state-map "\\f" #'describe-function)
219 (define-key evil-normal-state-map "\\v" #'describe-variable))
223 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
224 (add-hook 'eshell-mode-hook (lambda ()
225 (when (and (boundp 'evil-mode) evil-mode)
226 (dolist (key-fun '(("f" . ivy-switch-buffer)
227 ("b" . counsel-projectile-find-file)
228 ("r" . counsel-recentf)
229 ("t" . sd/hydra-window-layout/body)
230 ("e" . sd/toggle-project-eshell)
235 (evil-define-key 'emacs eshell-mode-map (kbd (concat evil-leader/leader (car key-fun))) (cdr key-fun))))
236 ;; (define-key eshell-mode-map (kbd "C-j") nil)
240 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
241 (with-eval-after-load "evil"
242 ;; file and directory explore
243 (define-key dired-mode-map (kbd "C-h") nil)
244 (define-key dired-mode-map (kbd "C-k") nil)
245 (evil-define-key 'normal dired-mode-map (kbd "H") 'dired-omit-mode)
246 (evil-define-key 'normal dired-mode-map (kbd "g") 'dired-goto-file)
247 (evil-define-key 'normal dired-mode-map (kbd "r") 'revert-buffer)
248 (evil-define-key 'normal dired-mode-map (kbd "i") 'dired-maybe-insert-subdir)
249 (evil-define-key 'normal dired-mode-map (kbd "TAB") 'diredp-next-subdir)
250 (evil-define-key 'normal dired-mode-map (kbd "J") 'diredp-next-subdir)
251 (evil-define-key 'normal dired-mode-map (kbd "K") 'diredp-prev-subdir)
252 (evil-define-key 'normal dired-mode-map (kbd "l") 'dired-display-file)
253 (evil-define-key 'normal dired-mode-map (kbd "f") 'dired-narrow)
254 (evil-define-key 'normal dired-mode-map (kbd "j") 'sd/dired-next-line)
255 (evil-define-key 'normal dired-mode-map (kbd "k") 'sd/dired-previous-line)
256 (evil-define-key 'normal dired-mode-map (kbd "h") 'sd/dired-up-directory)
257 (evil-define-key 'normal dired-mode-map [C-backspace] 'dired-up-directory)
258 ;; file and folder deletion
259 (evil-define-key 'normal dired-mode-map (kbd "m") 'dired-mark)
260 (evil-define-key 'normal dired-mode-map (kbd "u") 'dired-unmark)
261 (evil-define-key 'normal dired-mode-map (kbd "U") 'dired-unmark-all-marks)
262 (evil-define-key 'normal dired-mode-map (kbd "z") #'sd/dired-get-size)
263 (evil-define-key 'normal dired-mode-map (kbd "d") 'dired-flag-file-deletion)
264 (evil-define-key 'normal dired-mode-map (kbd "x") 'dired-do-flagged-delete)
265 (evil-define-key 'normal dired-mode-map (kbd "D") 'dired-do-delete)
266 ;; File and folder creation
267 (evil-define-key 'normal dired-mode-map (kbd "c") 'sd/dired-new-file)
268 (evil-define-key 'normal dired-mode-map (kbd "+") 'dired-create-directory)
269 (evil-define-key 'normal dired-mode-map (kbd "C") 'dired-do-copy)
270 (evil-define-key 'normal dired-mode-map (kbd "R") 'dired-do-rename)
272 ;; keep some normap mapping
273 (evil-define-key 'normal dired-mode-map (kbd "/") 'evil-ex-search-forward)
274 (evil-define-key 'normal dired-mode-map (kbd "n") 'evil-search-next)
275 (evil-define-key 'normal dired-mode-map (kbd "N") 'evil-search-previous)
276 (evil-define-key 'normal dired-mode-map (kbd "v") 'evil-visual-char))
281 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
282 ;; (with-eval-after-load "evil"
283 ;; (with-eval-after-load "expand-region"
284 ;; (define-key evil-normal-state-map (kbd "SPC") 'er/expand-region)
285 ;; (define-key evil-visual-state-map (kbd "SPC") 'er/expand-region)
286 ;; (define-key evil-visual-state-map (kbd "S-SPC") 'er/contract-region)
287 ;; (define-key evil-normal-state-map (kbd "S-SPC") 'er/contract-region)))
290 ** Org Mode (worf mode) and Lispy mode
291 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
292 (with-eval-after-load "evil"
293 (with-eval-after-load "lispy"
294 (evil-define-key 'normal lispy-mode-map (kbd "[") (lambda ()
296 (call-interactively #'lispy-backward)
298 (evil-define-key 'normal lispy-mode-map (kbd "]") (lambda ()
300 (call-interactively #'lispy-forward)
301 (evil-emacs-state))))
302 (with-eval-after-load "worf"
303 (evil-define-key 'normal worf-mode-map (kbd "[") (lambda ()
305 (call-interactively #'worf-backward)
307 (evil-define-key 'normal worf-mode-map (kbd "]") (lambda ()
309 (call-interactively #'worf-forward)
310 (evil-emacs-state)))))
314 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
315 (setq avy-keys '(?a ?s ?d ?g
321 ;; (setq avy-background t)
322 (setq avy-all-windows nil)
323 (with-eval-after-load "evil"
324 (dolist (map (list evil-normal-state-map
325 evil-visual-state-map
326 evil-motion-state-map))
327 (define-key map (kbd "gw") 'avy-goto-word-0-below)
328 (define-key map (kbd "gb") 'avy-goto-word-0-above)
329 (define-key map (kbd "ge") 'avy-goto-word-0)
330 (define-key map (kbd "gc") 'avy-goto-char)))
334 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
338 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
339 (dolist (mode '(c-mode-hook lua-mode-hook))
340 (add-hook mode (lambda () (setq indent-tabs-mode nil))))
343 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
344 (provide 'init-evil-mode)