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