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