8413280f355cb4963b401bae46b0332b1e5364ed
[dotfiles.git] / 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                                 ))
40
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)
48                                                     ;; (evil-delete-char)
49                                                     (setq evil-move-cursor-back org)))))
50 #+END_SRC
51
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
58   certain modes.
59 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
60   (defvar my-mode-list-to-use-emacs-as-insert '(emacs-lisp-mode
61                                                 org-mode
62                                                 eshell-mode
63                                                 lisp-interaction-mode)
64     "The mode in this list will consider insert state as emacs state by adding `advice-add' below.")
65
66   (defvar my-modes-use-emacs-init '(emacs-lisp-mode
67                                     org-mode
68                                     lisp-interaction-mode
69                                     eshell-mode
70                                     text-mode
71                                     package-menu-mode
72                                     paradox-menu-mode)
73     "The mode in this list will use emacs sate as a initial evil state.")
74
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)))))
84 #+END_SRC
85
86 * Evil-escape
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
90     :ensure t
91     :init
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))
96     :config
97     (evil-escape-mode))
98 #+END_SRC
99
100 * other extention
101 ** Evil-matchit
102 [[https://github.com/redguardtoo/evil-matchit]]
103 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
104   (use-package evil-matchit
105     :ensure t
106     :config
107     (global-evil-matchit-mode 1))
108 #+END_SRC
109
110 ** Evil-visualstar
111 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
112   (use-package evil-visualstar
113     :ensure t
114     :init
115     (setq evil-visualstar/persistent t)
116     :config
117     (global-evil-visualstar-mode))
118 #+END_SRC
119
120 ** Evil-surround
121 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
122   (use-package evil-surround
123     :ensure t
124     :config
125     (global-evil-surround-mode 1))
126 #+END_SRC
127 * Key bindings
128 ** Evil-Leader
129 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
130   (with-eval-after-load "evil-leader"
131     (cl-loop for (key . fun ) in '(("F" . counsel-projectile-switch-to-buffer)
132                                    ("f" . ivy-switch-buffer)
133                                    ("b" . counsel-projectile-find-file)
134                                    ("r" . ivy-recentf)
135                                    ("w" . save-buffer)
136                                    ("v" . evil-window-vsplit)
137                                    ("s" . evil-window-split)
138                                    ("t" . sd/hydra-gtags/body)
139                                    ("p" . sd/hydra-projectile/body)
140                                    ("q" . evil-quit)
141                                    ("g" . magit-status)
142                                    ("e" . sd/toggle-project-eshell)
143                                    ("d" . dired)
144                                    ("h" . help))
145              do (evil-leader/set-key key fun)))
146 #+END_SRC
147 ** Basic state bindings
148 There are three kinds key bindings
149 - prefix key is the leader key, defined by evil-leader.
150 - prefix key is the =Ctrl=,
151 - prefix key is =\=, 
152
153 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
154   (with-eval-after-load "evil"
155     (mapc (lambda (map)
156             (define-key map "\C-W s" 'evil-window-split)
157             (define-key map "\C-W v" 'evil-window-vsplit)
158             (define-key map "\C-h" 'evil-window-left)
159             (define-key map "\C-j" 'evil-window-down)
160             (define-key map "\C-k" 'evil-window-up)
161             (define-key map "\C-l" 'evil-window-right)
162             (define-key map (kbd "C->") (lambda () (interactive) (evil-window-increase-width 3)))
163             (define-key map (kbd "C-<") (lambda () (interactive) (evil-window-decrease-width 3)))
164             (define-key map (kbd "C-+") (lambda () (interactive) (evil-window-increase-height 3)))
165             (define-key map (kbd "C--") (lambda () (interactive) (evil-window-decrease-height 3)))
166             (define-key map (kbd "C-=") (lambda () (interactive) (balance-windows)))
167             ;; As ; has been defined as leader, so remap , to ; repeaat t/f
168             (define-key map (kbd ",") 'evil-repeat-find-char))
169           (list evil-normal-state-map evil-motion-state-map))
170
171     
172     ;; (define-key evil-normal-state-map  "s" nil)
173     ;; (define-key evil-normal-state-map  "sj" 'ivy-switch-buffer)
174     ;; normal state
175     ;; (define-key evil-normal-state-map (kbd "C-SPC") 'mode-line-other-buffer)
176     (define-key evil-normal-state-map (kbd "C-;") 'previous-multiframe-window)
177     ;; insert state
178     (define-key evil-insert-state-map (kbd "C-p") 'previous-line)
179     (define-key evil-insert-state-map (kbd "C-n") 'next-line)
180     (define-key evil-insert-state-map (kbd "C-h") 'delete-backward-char)
181     (define-key evil-insert-state-map (kbd "C-a") 'move-beginning-of-line)
182     (define-key evil-insert-state-map (kbd "C-e") 'move-end-of-line)
183     (define-key evil-insert-state-map (kbd "C-k") 'kill-line)
184     ;; motion mode
185     (define-key evil-motion-state-map (kbd "SPC") 'scroll-up-command)
186     (define-key evil-motion-state-map (kbd "S-SPC") 'scroll-down-command))
187 #+END_SRC
188
189
190 Let the search highlight persistent, https://stackoverflow.com/questions/25768036/emacs-evil-non-incremental-search-and-persistent-highlighting/34252236
191 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
192   (evil-select-search-module 'evil-search-module 'evil-search)
193
194   (with-eval-after-load "evil"
195     (define-key evil-normal-state-map "\\" nil)
196     (define-key evil-normal-state-map "\\\\" #'evil-ex-nohighlight)
197     (define-key evil-normal-state-map "\\f" #'describe-function)
198     (define-key evil-normal-state-map "\\v" #'describe-variable))
199 #+END_SRC
200
201 ** Eshell
202 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
203   (add-hook 'eshell-mode-hook (lambda ()
204                                 (when (and (boundp 'evil-mode) evil-mode)
205                                   (dolist (key-fun '(("f" . ivy-switch-buffer)
206                                                      ("b" . counsel-projectile-find-file)
207                                                      ("r" . counsel-recentf)
208                                                      ("t" . sd/hydra-window-layout/body)
209                                                      ("e" . sd/toggle-project-eshell)
210                                                      ("d" . dired)
211                                                      ("'" . other-window)
212                                                      ("h" . help)
213                                                      ("q" . evil-quit)))
214                                     (evil-define-key 'emacs eshell-mode-map (kbd (concat evil-leader/leader (car key-fun))) (cdr key-fun))))
215                                 ;; (define-key eshell-mode-map (kbd "C-j") nil)
216                                 ))
217
218   ;; 
219   ;; (add-hook 'eshell-mode-map
220   ;;        (lambda ()
221   ;;          (mapc (lambda (key-fun)
222   ;;                  (evil-define-key 'emacs eshell-mode-map (kbd (concat evil-leader/leader (car key-fun))) (cdr key-fun)))
223   ;;                '(("e" . dired)))))
224
225   ;; (add-hook 'eshell-mode-hook (lambda ()
226   ;;                               (loop for (key . fun) in '(
227   ;;                                                          ("e" . sd/toggle-project-eshell))
228   ;;                                     do (evil-define-key 'emacs eshell-mode-map (kbd (concat evil-leader/leader key)) fun))))
229 #+END_SRC
230 ** Dired mode
231 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
232   (with-eval-after-load "evil"
233     ;; file and directory explore
234     (define-key dired-mode-map (kbd "C-h") nil)
235     (define-key dired-mode-map (kbd "C-k") nil)
236     (evil-define-key 'normal dired-mode-map (kbd "H") 'dired-omit-mode)
237     (evil-define-key 'normal dired-mode-map (kbd "g") 'dired-goto-file)
238     (evil-define-key 'normal dired-mode-map (kbd "r") 'revert-buffer)
239     (evil-define-key 'normal dired-mode-map (kbd "i") 'dired-maybe-insert-subdir)
240     (evil-define-key 'normal dired-mode-map (kbd "TAB") 'diredp-next-subdir)
241     (evil-define-key 'normal dired-mode-map (kbd "J") 'diredp-next-subdir)
242     (evil-define-key 'normal dired-mode-map (kbd "K") 'diredp-prev-subdir)
243     (evil-define-key 'normal dired-mode-map (kbd "l") 'dired-display-file)
244     (evil-define-key 'normal dired-mode-map (kbd "f") 'dired-narrow)
245     (evil-define-key 'normal dired-mode-map (kbd "j") 'sd/dired-next-line)
246     (evil-define-key 'normal dired-mode-map (kbd "k") 'sd/dired-previous-line)
247     (evil-define-key 'normal dired-mode-map (kbd "h") 'sd/dired-up-directory)
248     (evil-define-key 'normal dired-mode-map [C-backspace] 'dired-up-directory)
249     ;; file and folder deletion
250     (evil-define-key 'normal dired-mode-map (kbd "m") 'dired-mark)
251     (evil-define-key 'normal dired-mode-map (kbd "u") 'dired-unmark)
252     (evil-define-key 'normal dired-mode-map (kbd "U") 'dired-unmark-all-marks)
253     (evil-define-key 'normal dired-mode-map (kbd "z") #'sd/dired-get-size)
254     (evil-define-key 'normal dired-mode-map (kbd "d") 'dired-flag-file-deletion)
255     (evil-define-key 'normal dired-mode-map (kbd "x") 'dired-do-flagged-delete)
256     (evil-define-key 'normal dired-mode-map (kbd "D") 'dired-do-delete)
257     ;; File and folder creation
258     (evil-define-key 'normal dired-mode-map (kbd "c") 'sd/dired-new-file)
259     (evil-define-key 'normal dired-mode-map (kbd "+") 'dired-create-directory)
260     (evil-define-key 'normal dired-mode-map (kbd "C") 'dired-do-copy)
261     (evil-define-key 'normal dired-mode-map (kbd "R") 'dired-do-rename)
262
263     ;; keep some normap mapping
264     (evil-define-key 'normal dired-mode-map (kbd "/") 'evil-ex-search-forward)
265     (evil-define-key 'normal dired-mode-map (kbd "n") 'evil-search-next)
266     (evil-define-key 'normal dired-mode-map (kbd "N") 'evil-search-previous)
267     (evil-define-key 'normal dired-mode-map (kbd "v") 'evil-visual-char))
268
269 #+END_SRC
270
271 ** expand region
272 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
273   (with-eval-after-load "evil"
274     (with-eval-after-load "expand-region"
275       (define-key evil-normal-state-map (kbd "SPC") 'er/expand-region)
276       (define-key evil-visual-state-map (kbd "SPC") 'er/expand-region)
277       (define-key evil-visual-state-map (kbd "S-SPC") 'er/contract-region)
278       (define-key evil-normal-state-map (kbd "S-SPC") 'er/contract-region)))
279 #+END_SRC
280
281 ** Org Mode (worf mode) and Lispy mode
282 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
283   (with-eval-after-load "evil"
284     (with-eval-after-load "lispy"
285       (evil-define-key 'normal lispy-mode-map (kbd "[") (lambda ()
286                                                           (interactive)
287                                                           (call-interactively #'lispy-backward)
288                                                           (evil-emacs-state)))
289       (evil-define-key 'normal lispy-mode-map (kbd "]") (lambda ()
290                                                           (interactive)
291                                                           (call-interactively #'lispy-forward)
292                                                           (evil-emacs-state))))
293     (with-eval-after-load "worf"
294       (evil-define-key 'normal worf-mode-map (kbd "[") (lambda ()
295                                                          (interactive)
296                                                          (call-interactively #'worf-backward)
297                                                          (evil-emacs-state)))
298       (evil-define-key 'normal worf-mode-map (kbd "]") (lambda ()
299                                                          (interactive)
300                                                          (call-interactively #'worf-forward)
301                                                          (evil-emacs-state)))
302       ;; (evil-define-key 'normal worf-mode-map (kbd "g") (lambda ()
303       ;;                                                    (interactive)
304       ;;                                                    (wspecial-worf-goto)
305       ;;                                                    (evil-emacs-state)))
306       ))
307 #+END_SRC
308
309 ** Avy & Evil
310 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
311   (with-eval-after-load "evil"
312     (dolist (map (list evil-normal-state-map
313                        evil-visual-state-map
314                        evil-motion-state-map))
315       (define-key map (kbd "J") 'avy-goto-line-below)
316       (define-key map (kbd "K") 'avy-goto-line-above)
317       (define-key map (kbd "F") 'avy-goto-char)
318       (define-key map (kbd "W") 'avy-goto-char-timer)))
319 #+END_SRC
320
321 ** ggtags
322 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
323
324 #+END_SRC
325 * Others
326 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
327   (dolist (mode '(c-mode-hook lua-mode-hook))
328     (add-hook mode (lambda () (setq indent-tabs-mode nil))))
329 #+END_SRC
330 * Provide 
331 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
332   (provide 'init-evil-mode)
333 #+END_SRC