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     :config
  25     (require 'evil-leader)
  26     (global-evil-leader-mode)
  27     (evil-mode t))
  28 #+END_SRC
  29
  30 ** Initial mode and state config
  31 - Use =normal= as the default state but exclude some special modes.
  32 - Bind =[escape]=  to =normal= mode. This only works on GUI Emacs. If need to work on Terminal, shoudl also bind =(kbd
  33   "<ESC>)=, but this will make the combined key =M-= not wor.
  34 - Not alias =insert= state to =emacs= state, as it break some vi's feature in insert mode, such as column edit. Instead,
  35   here add a advice function to change the sate as emacs when enter insert mode, but this is only limited in some
  36   certain modes.
  37 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
  38   (defvar my-mode-list-to-use-emacs-as-insert '(emacs-lisp-mode org-mode eshell-mode lisp-interaction-mode)
  39     "The mode in this list will consider insert state as emacs state by adding `advice-add' below.")
  40
  41   (defvar my-modes-use-emacs-init '(emacs-lisp-mode org-mode lisp-interaction-mode eshell-mode text-mode)
  42     "The mode in this list will use emacs sate as a initial evil state.")
  43
  44   (with-eval-after-load "evil"
  45     (setq evil-default-state 'normal)
  46       ;; (defalias 'evil-inset-mode 'evil-emacs-state)
  47     (define-key evil-emacs-state-map [escape] 'evil-normal-state)
  48     ;; (define-key evil-emacs-state-map (kbd "<ESC>") 'evil-normal-state)
  49     (dolist (mode my-modes-use-emacs-init) (evil-set-initial-state mode 'emacs))
  50     (advice-add 'evil-insert-state :after (lambda (&optional arg)
  51                                             (when (memq major-mode my-mode-list-to-use-emacs-as-insert)
  52                                               (evil-emacs-state)))))
  53 #+END_SRC
  54
  55
  56 * Evil-escape
  57 [[https://github.com/syl20bnr/evil-escape][evil-escape]], escape from anything with customizable key sequence.
  58 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
  59   (use-package evil-escape
  60     :ensure t
  61     :init
  62     (setq-default evil-escape-delay 0.2)
  63     (setq-default evil-escape-key-sequence "jj")
  64     (setq-default evil-escape-excluded-states '(normal visual motion emacs))
  65     (setq-default evil-escape-excluded-major-modes '(emacs-lisp-mode org-mode))
  66     :config
  67     (evil-escape-mode))
  68 #+END_SRC
  69
  70 * Evil-Leader
  71 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
  72   (use-package evil-leader
  73     :ensure t
  74     :config
  75     (global-evil-leader-mode)
  76     (evil-leader/set-leader ";")
  77     ;; Buffer & File
  78     (evil-leader/set-key "f" 'ido-switch-buffer)
  79     (evil-leader/set-key "w" 'evil-save)
  80     (evil-leader/set-key "r" 'ivy-recentf)
  81     (evil-leader/set-key "w" 'save-buffer)
  82     (evil-leader/set-key "o" 'ido-find-file)
  83     (evil-leader/set-key "p" 'projectile-find-file)
  84     ;; Window
  85     (evil-leader/set-key "s" 'evil-window-split)
  86     (evil-leader/set-key "v" 'evil-window-vsplit)
  87     (evil-leader/set-key "q" 'evil-quit)
  88     ;; others
  89     (evil-leader/set-key "h" 'help)
  90     (evil-leader/set-key "g" 'magit-status)
  91     (evil-leader/set-key "d" 'dired)
  92     (evil-leader/set-key "e" 'sd/toggle-project-eshell))
  93
  94   (with-eval-after-load "evil"
  95     (evil-define-key 'emacs eshell-mode-map (kbd ";e") 'sd/toggle-project-eshell)
  96     (evil-define-key 'emacs eshell-mode-map (kbd ";d") 'dired)
  97     (evil-define-key 'emacs eshell-mode-map (kbd "C-;") 'mode-line-other-buffer))
  98
  99 #+END_SRC
 100
 101 * other extention
 102 ** Evil-matchit
 103 [[https://github.com/redguardtoo/evil-matchit]]
 104 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 105   (use-package evil-matchit
 106     :ensure t
 107     :config
 108     (global-evil-matchit-mode 1))
 109 #+END_SRC
 110
 111 ** Evil-visualstar
 112 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 113   (use-package evil-visualstar
 114     :ensure t
 115     :init
 116     (setq evil-visualstar/persistent t)
 117     :config
 118     (global-evil-visualstar-mode))
 119 #+END_SRC
 120 * Key bindings
 121 There are three kinds key bindings
 122 - prefix key is the leader key, defined by evil-leader. *;*
 123 - prefix key is the =Ctrl=,
 124 - prefix key is =\=,
 125
 126 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 127   (with-eval-after-load "evil"
 128     (mapc (lambda (map)
 129             (define-key map "\C-W s" 'evil-window-split)
 130             (define-key map "\C-W v" 'evil-window-vsplit)
 131             (define-key map "\C-h" 'evil-window-left)
 132             (define-key map "\C-j" 'evil-window-down)
 133             (define-key map "\C-k" 'evil-window-up)
 134             (define-key map "\C-l" 'evil-window-right)
 135             (define-key map (kbd "C->") (lambda () (interactive) (evil-window-increase-width 3)))
 136             (define-key map (kbd "C-<") (lambda () (interactive) (evil-window-decrease-width 3)))
 137             (define-key map (kbd "C-+") (lambda () (interactive) (evil-window-increase-height 3)))
 138             (define-key map (kbd "C--") (lambda () (interactive) (evil-window-decrease-height 3)))
 139             (define-key map (kbd "C-=") (lambda () (interactive) (balance-windows))))
 140           (list evil-normal-state-map evil-motion-state-map))
 141
 142     (define-key evil-normal-state-map (kbd "C-SPC") 'mode-line-other-buffer)
 143     (define-key evil-normal-state-map (kbd "C-;") 'previous-multiframe-window)
 144
 145     (define-key evil-insert-state-map (kbd "C-p") 'previous-line)
 146     (define-key evil-insert-state-map (kbd "C-n") 'next-line))
 147
 148 #+END_SRC
 149
 150
 151 Let the search highlight persistent, https://stackoverflow.com/questions/25768036/emacs-evil-non-incremental-search-and-persistent-highlighting/34252236
 152 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 153   (evil-select-search-module 'evil-search-module 'evil-search)
 154
 155   (with-eval-after-load "evil"
 156     (define-key evil-normal-state-map "\\" nil)
 157     (define-key evil-normal-state-map "\\\\" #'evil-ex-nohighlight))
 158 #+END_SRC
 159 * Others
 160 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 161   (dolist (mode '(c-mode-hook lua-mode-hook))
 162     (add-hook mode (lambda () (setq indent-tabs-mode nil))))
 163 #+END_SRC
 164 * Provide
 165 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 166   (provide 'init-evil-mode)
 167 #+END_SRC