Emacs - some dired mapping
[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 * Evil-Leader
91 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
92   (with-eval-after-load "evil-leader"
93     ;; Buffer & File
94     (evil-leader/set-key "f" 'ido-switch-buffer)
95     (evil-leader/set-key "w" 'evil-save)
96     (evil-leader/set-key "r" 'ivy-recentf)
97     (evil-leader/set-key "w" 'save-buffer)
98     (evil-leader/set-key "o" 'ido-find-file)
99     (evil-leader/set-key "p" 'projectile-find-file)
100     ;; Window
101     (evil-leader/set-key "s" 'evil-window-split)
102     (evil-leader/set-key "v" 'evil-window-vsplit)
103     (evil-leader/set-key "q" 'evil-quit)
104     ;; others
105     (evil-leader/set-key "h" 'help)
106     (evil-leader/set-key "g" 'magit-status)
107     (evil-leader/set-key "d" 'dired)
108     (evil-leader/set-key "e" 'sd/toggle-project-eshell))
109
110   (with-eval-after-load "evil"
111     (evil-define-key 'emacs eshell-mode-map (kbd ";e") 'sd/toggle-project-eshell)
112     (evil-define-key 'emacs eshell-mode-map (kbd ";d") 'dired)
113     (evil-define-key 'emacs eshell-mode-map (kbd "C-;") 'mode-line-other-buffer))
114
115 #+END_SRC
116
117 * other extention
118 ** Evil-matchit
119 [[https://github.com/redguardtoo/evil-matchit]]
120 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
121   (use-package evil-matchit
122     :ensure t
123     :config
124     (global-evil-matchit-mode 1))
125 #+END_SRC
126
127 ** Evil-visualstar
128 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
129   (use-package evil-visualstar
130     :ensure t
131     :init
132     (setq evil-visualstar/persistent t)
133     :config
134     (global-evil-visualstar-mode))
135 #+END_SRC
136
137 ** Evil-surround
138 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
139   (use-package evil-surround
140     :ensure t
141     :config
142     (global-evil-surround-mode 1))
143 #+END_SRC
144 * Key bindings
145 There are three kinds key bindings
146 - prefix key is the leader key, defined by evil-leader. *;*
147 - prefix key is the =Ctrl=,
148 - prefix key is =\=, 
149
150 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
151   (with-eval-after-load "evil"
152     (mapc (lambda (map)
153             (define-key map "\C-W s" 'evil-window-split)
154             (define-key map "\C-W v" 'evil-window-vsplit)
155             (define-key map "\C-h" 'evil-window-left)
156             (define-key map "\C-j" 'evil-window-down)
157             (define-key map "\C-k" 'evil-window-up)
158             (define-key map "\C-l" 'evil-window-right)
159             (define-key map (kbd "C->") (lambda () (interactive) (evil-window-increase-width 3)))
160             (define-key map (kbd "C-<") (lambda () (interactive) (evil-window-decrease-width 3)))
161             (define-key map (kbd "C-+") (lambda () (interactive) (evil-window-increase-height 3)))
162             (define-key map (kbd "C--") (lambda () (interactive) (evil-window-decrease-height 3)))
163             (define-key map (kbd "C-=") (lambda () (interactive) (balance-windows))))
164           (list evil-normal-state-map evil-motion-state-map))
165     ;; normal state
166     (define-key evil-normal-state-map (kbd "C-SPC") 'mode-line-other-buffer)
167     (define-key evil-normal-state-map (kbd "C-;") 'previous-multiframe-window)
168     ;; insert state
169     (define-key evil-insert-state-map (kbd "C-p") 'previous-line)
170     (define-key evil-insert-state-map (kbd "C-n") 'next-line)
171     (define-key evil-insert-state-map (kbd "C-h") 'delete-backward-char)
172     (define-key evil-insert-state-map (kbd "C-a") 'move-beginning-of-line)
173     (define-key evil-insert-state-map (kbd "C-e") 'move-end-of-line)
174     (define-key evil-insert-state-map (kbd "C-k") 'kill-line)
175     ;; motion mode
176     (define-key evil-motion-state-map (kbd "SPC") 'scroll-up-command)
177     (define-key evil-motion-state-map (kbd "S-SPC") 'scroll-down-command))
178 #+END_SRC
179
180
181 Let the search highlight persistent, https://stackoverflow.com/questions/25768036/emacs-evil-non-incremental-search-and-persistent-highlighting/34252236
182 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
183   (evil-select-search-module 'evil-search-module 'evil-search)
184
185   (with-eval-after-load "evil"
186     (define-key evil-normal-state-map "\\" nil)
187     (define-key evil-normal-state-map "\\\\" #'evil-ex-nohighlight))
188 #+END_SRC
189
190 - Dired mode
191 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
192   (with-eval-after-load "evil"
193     ;; file and directory explore
194     (define-key dired-mode-map (kbd "C-h") nil)
195     (define-key dired-mode-map (kbd "C-k") nil)
196     (evil-define-key 'normal dired-mode-map (kbd "H") 'dired-omit-mode)
197     (evil-define-key 'normal dired-mode-map (kbd "g") 'dired-goto-file)
198     (evil-define-key 'normal dired-mode-map (kbd "r") 'revert-buffer)
199     (evil-define-key 'normal dired-mode-map (kbd "i") 'dired-maybe-insert-subdir)
200     (evil-define-key 'normal dired-mode-map (kbd "TAB") 'diredp-next-subdir)
201     (evil-define-key 'normal dired-mode-map (kbd "J") 'diredp-next-subdir)
202     (evil-define-key 'normal dired-mode-map (kbd "K") 'diredp-prev-subdir)
203     (evil-define-key 'normal dired-mode-map (kbd "l") 'dired-display-file)
204     (evil-define-key 'normal dired-mode-map (kbd "f") 'dired-narrow)
205     (evil-define-key 'normal dired-mode-map (kbd "j") 'sd/dired-next-line)
206     (evil-define-key 'normal dired-mode-map (kbd "k") 'sd/dired-previous-line)
207     (evil-define-key 'normal dired-mode-map (kbd "h") 'sd/dired-up-directory)
208     (evil-define-key 'normal dired-mode-map [C-backspace] 'dired-up-directory)
209     ;; file and folder deletion
210     (evil-define-key 'normal dired-mode-map (kbd "m") 'dired-mark)
211     (evil-define-key 'normal dired-mode-map (kbd "u") 'dired-unmark)
212     (evil-define-key 'normal dired-mode-map (kbd "U") 'dired-unmark-all-marks)
213     (evil-define-key 'normal dired-mode-map (kbd "z") #'sd/dired-get-size)
214     (evil-define-key 'normal dired-mode-map (kbd "d") 'dired-flag-file-deletion)
215     (evil-define-key 'normal dired-mode-map (kbd "x") 'dired-do-flagged-delete)
216     (evil-define-key 'normal dired-mode-map (kbd "D") 'dired-do-delete)
217     ;; File and folder creation
218     (evil-define-key 'normal dired-mode-map (kbd "c") 'sd/dired-new-file)
219     (evil-define-key 'normal dired-mode-map (kbd "+") 'dired-create-directory)
220     (evil-define-key 'normal dired-mode-map (kbd "C") 'dired-do-copy)
221     (evil-define-key 'normal dired-mode-map (kbd "R") 'dired-do-rename)
222
223     ;; keep some normap mapping
224     (evil-define-key 'normal dired-mode-map (kbd "/") 'evil-ex-search-forward)
225     (evil-define-key 'normal dired-mode-map (kbd "n") 'evil-search-next)
226     (evil-define-key 'normal dired-mode-map (kbd "N") 'evil-search-previous)
227     (evil-define-key 'normal dired-mode-map (kbd "v") 'evil-visual-char))
228
229 #+END_SRC
230
231 - expand region
232 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
233   (with-eval-after-load "evil"
234     (with-eval-after-load "expand-region"
235       (define-key evil-normal-state-map (kbd "SPC") 'er/expand-region)
236       (define-key evil-visual-state-map (kbd "SPC") 'er/expand-region)
237       (define-key evil-visual-state-map (kbd "S-SPC") 'er/contract-region)
238       (define-key evil-normal-state-map (kbd "S-SPC") 'er/contract-region)))
239 #+END_SRC
240
241 * Others
242 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
243   (dolist (mode '(c-mode-hook lua-mode-hook))
244     (add-hook mode (lambda () (setq indent-tabs-mode nil))))
245 #+END_SRC
246 * Provide 
247 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
248   (provide 'init-evil-mode)
249 #+END_SRC