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" . sd/swith-to-buffer)
 122                                    ("b" . projectile-find-file)
 123                                    ("r" . ivy-recentf)
 124                                    ("w" . save-buffer)
 125                                    ("v" . evil-window-vsplit)
 126                                    ("s" . evil-window-split)
 127                                    ("t" . sd/hydra-window-layout/body)
 128                                    ("p" . sd/hydra-projectile/body)
 129                                    ("q" . evil-quit)
 130                                    ("g" . magit-status)
 131                                    ("e" . sd/toggle-project-eshell)
 132                                    ("d" . dired)
 133                                    ("h" . help))
 134              do (evil-leader/set-key key fun)))
 135 #+END_SRC
 136 ** Basic state bindings
 137 There are three kinds key bindings
 138 - prefix key is the leader key, defined by evil-leader.
 139 - prefix key is the =Ctrl=,
 140 - prefix key is =\=,
 141
 142 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 143   (with-eval-after-load "evil"
 144     (mapc (lambda (map)
 145             (define-key map "\C-W s" 'evil-window-split)
 146             (define-key map "\C-W v" 'evil-window-vsplit)
 147             (define-key map "\C-h" 'evil-window-left)
 148             (define-key map "\C-j" 'evil-window-down)
 149             (define-key map "\C-k" 'evil-window-up)
 150             (define-key map "\C-l" 'evil-window-right)
 151             ;; (define-key map (kbd "C->") (lambda () (interactive) (evil-window-increase-width 3)))
 152             ;; (define-key map (kbd "C-<") (lambda () (interactive) (evil-window-decrease-width 3)))
 153             ;; (define-key map (kbd "C-+") (lambda () (interactive) (evil-window-increase-height 3)))
 154             ;; (define-key map (kbd "C--") (lambda () (interactive) (evil-window-decrease-height 3)))
 155             ;; (define-key map (kbd "C-=") (lambda () (interactive) (balance-windows)))
 156             ;; As ; has been defined as leader, so remap , to ; repeaat t/f
 157             (define-key map (kbd ",") 'evil-repeat-find-char))
 158           (list evil-normal-state-map evil-motion-state-map))
 159
 160     ;; insert state
 161     (cl-loop for (key-sequence . fun) in '(("C-;" . iedit-mode)
 162                                            ("C-n" . next-line)
 163                                            ("C-p" . previous-line)
 164                                            ("C-a" . move-beginning-of-line)
 165                                            ("C-e" . move-end-of-line)
 166                                            ("C-h" . delete-backward-char)
 167                                            ("C-k" . kill-line))
 168              do (define-key evil-insert-state-map (kbd key-sequence) fun))
 169
 170     ;; remap some vim keybindings
 171     (dolist (map (list
 172                   evil-normal-state-map
 173                   evil-visual-state-map
 174                   evil-motion-state-map))
 175       (cl-loop for (keys . fun) in '(("'" . evil-goto-mark)
 176                                      ("`" . evil-goto-mark-line))
 177                do (define-key map (kbd keys) fun)))
 178     ;; motion mode
 179     (define-key evil-motion-state-map (kbd "SPC") 'scroll-up-command)
 180     (define-key evil-motion-state-map (kbd "S-SPC") 'scroll-down-command))
 181 #+END_SRC
 182
 183
 184 Let the search highlight persistent, https://stackoverflow.com/questions/25768036/emacs-evil-non-incremental-search-and-persistent-highlighting/34252236
 185 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 186   (evil-select-search-module 'evil-search-module 'evil-search)
 187
 188   (with-eval-after-load "evil"
 189     (define-key evil-normal-state-map "\\" nil)
 190     (define-key evil-normal-state-map "\\\\" #'evil-ex-nohighlight)
 191     (define-key evil-normal-state-map "\\f" #'describe-function)
 192     (define-key evil-normal-state-map "\\v" #'describe-variable))
 193 #+END_SRC
 194
 195 Go, =g= command
 196
 197 - =g#= =g*= :: same as =#=, =*=,  but without using "\<" and "\>"
 198 - =g$= :: same as =$=
 199 - =g&= :: repease last =:s= on all lines
 200 - g', g`, like ' ` but without changing the jumplist
 201 - g+, g-
 202 - g; ::
 203 gs
 204
 205 ** Eshell
 206 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 207   (add-hook 'eshell-mode-hook (lambda ()
 208                                 (when (and (boundp 'evil-mode) evil-mode)
 209                                   (dolist (key-fun '(("f" . sd/swith-to-buffer)
 210                                                      ("b" . projectile-find-file)
 211                                                      ("r" . ivy-recentf)
 212                                                      ("t" . sd/hydra-window-layout/body)
 213                                                      ("e" . sd/toggle-project-eshell)
 214                                                      ("d" . dired)
 215                                                      ("'" . other-window)
 216                                                      ("h" . help)
 217                                                      ("q" . evil-quit)))
 218                                     (evil-define-key 'emacs eshell-mode-map (kbd (concat evil-leader/leader (car key-fun))) (cdr key-fun))))))
 219 #+END_SRC
 220 ** Dired mode
 221 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 222   (with-eval-after-load "evil"
 223     ;; file and directory explore
 224     (define-key dired-mode-map (kbd "C-h") nil)
 225     (define-key dired-mode-map (kbd "C-k") nil)
 226     (evil-define-key 'normal dired-mode-map (kbd "H") 'dired-omit-mode)
 227     (evil-define-key 'normal dired-mode-map (kbd "g") 'dired-goto-file)
 228     (evil-define-key 'normal dired-mode-map (kbd "r") 'revert-buffer)
 229     (evil-define-key 'normal dired-mode-map (kbd "i") 'dired-maybe-insert-subdir)
 230     (evil-define-key 'normal dired-mode-map (kbd "TAB") 'diredp-next-subdir)
 231     (evil-define-key 'normal dired-mode-map (kbd "J") 'diredp-next-subdir)
 232     (evil-define-key 'normal dired-mode-map (kbd "K") 'diredp-prev-subdir)
 233     (evil-define-key 'normal dired-mode-map (kbd "l") 'dired-display-file)
 234     (evil-define-key 'normal dired-mode-map (kbd "f") 'dired-narrow)
 235     (evil-define-key 'normal dired-mode-map (kbd "j") 'sd/dired-next-line)
 236     (evil-define-key 'normal dired-mode-map (kbd "k") 'sd/dired-previous-line)
 237     (evil-define-key 'normal dired-mode-map (kbd "h") 'sd/dired-up-directory)
 238     (evil-define-key 'normal dired-mode-map [C-backspace] 'dired-up-directory)
 239     ;; file and folder deletion
 240     (evil-define-key 'normal dired-mode-map (kbd "m") 'dired-mark)
 241     (evil-define-key 'normal dired-mode-map (kbd "u") 'dired-unmark)
 242     (evil-define-key 'normal dired-mode-map (kbd "U") 'dired-unmark-all-marks)
 243     (evil-define-key 'normal dired-mode-map (kbd "z") #'sd/dired-get-size)
 244     (evil-define-key 'normal dired-mode-map (kbd "d") 'dired-flag-file-deletion)
 245     (evil-define-key 'normal dired-mode-map (kbd "x") 'dired-do-flagged-delete)
 246     (evil-define-key 'normal dired-mode-map (kbd "D") 'dired-do-delete)
 247     ;; File and folder creation
 248     (evil-define-key 'normal dired-mode-map (kbd "c") 'sd/dired-new-file)
 249     (evil-define-key 'normal dired-mode-map (kbd "+") 'dired-create-directory)
 250     (evil-define-key 'normal dired-mode-map (kbd "C") 'dired-do-copy)
 251     (evil-define-key 'normal dired-mode-map (kbd "R") 'dired-do-rename)
 252
 253     ;; keep some normap mapping
 254     (evil-define-key 'normal dired-mode-map (kbd "/") 'evil-ex-search-forward)
 255     (evil-define-key 'normal dired-mode-map (kbd "n") 'evil-search-next)
 256     (evil-define-key 'normal dired-mode-map (kbd "N") 'evil-search-previous)
 257     (evil-define-key 'normal dired-mode-map (kbd "v") 'evil-visual-char))
 258
 259 #+END_SRC
 260
 261 ** expand region
 262 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 263   ;; (with-eval-after-load "evil"
 264   ;;   (with-eval-after-load "expand-region"
 265   ;;     (define-key evil-normal-state-map (kbd "SPC") 'er/expand-region)
 266   ;;     (define-key evil-visual-state-map (kbd "SPC") 'er/expand-region)
 267   ;;     (define-key evil-visual-state-map (kbd "S-SPC") 'er/contract-region)
 268   ;;     (define-key evil-normal-state-map (kbd "S-SPC") 'er/contract-region)))
 269 #+END_SRC
 270
 271 ** Org Mode (worf mode) and Lispy mode
 272 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 273   (with-eval-after-load "evil"
 274     (with-eval-after-load "lispy"
 275       (evil-define-key 'normal lispy-mode-map (kbd "[") (lambda ()
 276                                                           (interactive)
 277                                                           (call-interactively #'lispy-backward)
 278                                                           (evil-emacs-state)))
 279       (evil-define-key 'normal lispy-mode-map (kbd "]") (lambda ()
 280                                                           (interactive)
 281                                                           (call-interactively #'lispy-forward)
 282                                                           (evil-emacs-state))))
 283     (with-eval-after-load "worf"
 284       (evil-define-key 'normal worf-mode-map (kbd "[") (lambda ()
 285                                                          (interactive)
 286                                                          (call-interactively #'worf-backward)
 287                                                          (evil-emacs-state)))
 288       (evil-define-key 'normal worf-mode-map (kbd "]") (lambda ()
 289                                                          (interactive)
 290                                                          (call-interactively #'worf-forward)
 291                                                          (evil-emacs-state)))))
 292 #+END_SRC
 293
 294 ** Avy & Evil
 295 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 296   (setq avy-keys '(?a ?s ?d ?g
 297                       ?h ?k ?l
 298                       ?q ?w ?e ?r ?t
 299                       ?y ?u ?i ?o ?p
 300                       ?z ?x ?c ?v ?b
 301                       ?n ?m ?f ?j 59))
 302   ;; (setq avy-background t)
 303   (setq avy-all-windows nil)
 304   (with-eval-after-load "evil"
 305     (dolist (map (list evil-normal-state-map
 306                        evil-visual-state-map
 307                        evil-motion-state-map))
 308       (define-key map (kbd "gw") 'avy-goto-word-0-below)
 309       (define-key map (kbd "gb") 'avy-goto-word-0-above)
 310       (define-key map (kbd "ge") 'avy-goto-word-0)
 311       (define-key map (kbd "gc") 'avy-goto-char)))
 312 #+END_SRC
 313
 314 ** ggtags
 315 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 316
 317 #+END_SRC
 318 * Others
 319 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 320   (dolist (mode '(c-mode-hook lua-mode-hook))
 321     (add-hook mode (lambda () (setq indent-tabs-mode nil))))
 322 #+END_SRC
 323 * Provide
 324 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 325   (provide 'init-evil-mode)
 326 #+END_SRC