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))
25 (require 'evil-leader)
26 (global-evil-leader-mode)
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
37 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
38 (defvar my-mode-list-to-use-emacs-as-insert '(emacs-lisp-mode
41 lisp-interaction-mode)
42 "The mode in this list will consider insert state as emacs state by adding `advice-add' below.")
44 (defvar my-modes-use-emacs-init '(emacs-lisp-mode
51 "The mode in this list will use emacs sate as a initial evil state.")
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)))))
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
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))
80 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
81 (use-package evil-leader
84 (global-evil-leader-mode)
85 (evil-leader/set-leader ";")
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)
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)
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))
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))
112 [[https://github.com/redguardtoo/evil-matchit]]
113 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
114 (use-package evil-matchit
117 (global-evil-matchit-mode 1))
121 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
122 (use-package evil-visualstar
125 (setq evil-visualstar/persistent t)
127 (global-evil-visualstar-mode))
131 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
132 (use-package evil-surround
135 (global-evil-surround-mode 1))
138 There are three kinds key bindings
139 - prefix key is the leader key, defined by evil-leader. *;*
140 - prefix key is the =Ctrl=,
143 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
144 (with-eval-after-load "evil"
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))
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)
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)
166 (define-key evil-motion-state-map (kbd "SPC") 'scroll-up-command)
167 (define-key evil-motion-state-map (kbd "S-SPC") 'scroll-down-command))
171 Let the search highlight persistent, https://stackoverflow.com/questions/25768036/emacs-evil-non-incremental-search-and-persistent-highlighting/34252236
172 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
173 (evil-select-search-module 'evil-search-module 'evil-search)
175 (with-eval-after-load "evil"
176 (define-key evil-normal-state-map "\\" nil)
177 (define-key evil-normal-state-map "\\\\" #'evil-ex-nohighlight))
181 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
182 (with-eval-after-load "evil"
183 ;; file and directory explore
184 (evil-define-key 'normal dired-mode-map (kbd "H") 'dired-omit-mode)
185 (evil-define-key 'normal dired-mode-map (kbd "g") 'dired-goto-file)
186 (evil-define-key 'normal dired-mode-map (kbd "r") 'revert-buffer)
187 (evil-define-key 'normal dired-mode-map (kbd "i") 'dired-maybe-insert-subdir)
188 (evil-define-key 'normal dired-mode-map (kbd "TAB") 'diredp-next-subdir)
189 (evil-define-key 'normal dired-mode-map (kbd "J") 'diredp-next-subdir)
190 (evil-define-key 'normal dired-mode-map (kbd "K") 'diredp-prev-subdir)
191 (evil-define-key 'normal dired-mode-map (kbd "l") 'dired-display-file)
192 (evil-define-key 'normal dired-mode-map (kbd "f") 'dired-narrow)
193 (evil-define-key 'normal dired-mode-map (kbd "j") 'dired-next-line)
194 (evil-define-key 'normal dired-mode-map (kbd "k") 'dired-previous-line)
195 (evil-define-key 'normal dired-mode-map [C-backspace] 'dired-up-directory)
196 ;; file and folder deletion
197 (evil-define-key 'normal dired-mode-map (kbd "m") 'dired-mark)
198 (evil-define-key 'normal dired-mode-map (kbd "u") 'dired-unmark)
199 (evil-define-key 'normal dired-mode-map (kbd "U") 'dired-unmark-all-marks)
200 (evil-define-key 'normal dired-mode-map (kbd "z") #'sd/dired-get-size)
201 (evil-define-key 'normal dired-mode-map (kbd "d") 'dired-flag-file-deletion)
202 (evil-define-key 'normal dired-mode-map (kbd "x") 'dired-do-flagged-delete)
203 (evil-define-key 'normal dired-mode-map (kbd "D") 'dired-do-delete)
204 ;; File and folder creation
205 (evil-define-key 'normal dired-mode-map (kbd "c") 'sd/dired-new-file)
206 (evil-define-key 'normal dired-mode-map (kbd "C") 'dired-create-directory)
208 ;; keep some normap mapping
209 (evil-define-key 'normal dired-mode-map (kbd "/") 'evil-ex-search-forward)
210 (evil-define-key 'normal dired-mode-map (kbd "n") 'evil-search-next)
211 (evil-define-key 'normal dired-mode-map (kbd "N") 'evil-search-previous)
212 (evil-define-key 'normal dired-mode-map (kbd "v") 'evil-visual-char))
217 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
218 (with-eval-after-load "evil"
219 (with-eval-after-load "expand-region"
220 (define-key evil-normal-state-map (kbd "SPC") 'er/expand-region)
221 (define-key evil-visual-state-map (kbd "SPC") 'er/expand-region)
222 (define-key evil-visual-state-map (kbd "S-SPC") 'er/contract-region)
223 (define-key evil-normal-state-map (kbd "S-SPC") 'er/contract-region)))
227 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
228 (dolist (mode '(c-mode-hook lua-mode-hook))
229 (add-hook mode (lambda () (setq indent-tabs-mode nil))))
232 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
233 (provide 'init-evil-mode)