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