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-visual-state-cursor '("orange" box))
  20     (setq evil-insert-state-cursor '("red" bar))
  21     (setq evil-replace-state-cursor '("red" bar))
  22     (setq evil-operator-state-cursor '("red" hollow))
  23     :config
  24     (require 'evil-leader)
  25     (global-evil-leader-mode)
  26     (evil-mode t)
  27
  28     (define-key evil-normal-state-map "\C-W s" 'evil-window-split)
  29     (define-key evil-normal-state-map "\C-W v" 'evil-window-vsplit)
  30     (define-key evil-normal-state-map "\C-h" 'evil-window-left)
  31     (define-key evil-normal-state-map "\C-j" 'evil-window-down)
  32     (define-key evil-normal-state-map "\C-k" 'evil-window-up)
  33     (define-key evil-normal-state-map "\C-l" 'evil-window-right)
  34     (define-key evil-normal-state-map (kbd "C->") (lambda () (interactive) (evil-window-increase-width 3)))
  35     (define-key evil-normal-state-map (kbd "C-<") (lambda () (interactive) (evil-window-decrease-width 3)))
  36     (define-key evil-normal-state-map (kbd "C-+") (lambda () (interactive) (evil-window-increase-height 3)))
  37     (define-key evil-normal-state-map (kbd "C--") (lambda () (interactive) (evil-window-decrease-height 3)))
  38     (define-key evil-normal-state-map (kbd "C-=") (lambda () (interactive) (balance-windows))))
  39 #+END_SRC
  40
  41 ** Initial mode and state config
  42 - Use =normal= as the default state but exclude some special modes.
  43 - Bind =[escape]=  to =normal= mode. This only works on GUI Emacs. If need to work on Terminal, shoudl also bind =(kbd
  44   "<ESC>)=, but this will make the combined key =M-= not wor.
  45 - Not alias =insert= state to =emacs= state, as it break some vi's feature in insert mode, such as column edit. Instead,
  46   here add a advice function to change the sate as emacs when enter insert mode, but this is only limited in some
  47   certain modes.
  48 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
  49   (defvar my-mode-list-to-use-emacs-as-insert '(emacs-lisp-mode org-mode eshell-mode lisp-interaction-mode)
  50     "The mode in this list will consider insert state as emacs state by adding `advice-add' below.")
  51
  52   (defvar my-modes-use-emacs-init '(emacs-lisp-mode org-mode lisp-interaction-mode eshell-mode text-mode)
  53     "The mode in this list will use emacs sate as a initial evil state.")
  54
  55   (with-eval-after-load "evil"
  56     (setq evil-default-state 'normal)
  57       ;; (defalias 'evil-inset-mode 'evil-emacs-state)
  58     (define-key evil-emacs-state-map [escape] 'evil-normal-state)
  59     ;; (define-key evil-emacs-state-map (kbd "<ESC>") 'evil-normal-state)
  60     (dolist (mode my-modes-use-emacs-init) (evil-set-initial-state mode 'emacs))
  61     (advice-add 'evil-insert-state :after (lambda (&optional arg)
  62                                             (when (memq major-mode my-mode-list-to-use-emacs-as-insert)
  63                                               (evil-emacs-state)))))
  64
  65
  66 #+END_SRC
  67
  68 ** state key mapping
  69 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
  70   (define-key evil-normal-state-map (kbd "C-<SPACE>") 'previous-buffer)
  71 #+END_SRC
  72 * Evil-escape
  73 [[https://github.com/syl20bnr/evil-escape][evil-escape]], escape from anything with customizable key sequence.
  74 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
  75   (use-package evil-escape
  76     :ensure t
  77     :init
  78     (setq-default evil-escape-delay 0.2)
  79     (setq-default evil-escape-key-sequence "jj")
  80     (setq-default evil-escape-excluded-states '(normal visual motion emacs))
  81     (setq-default evil-escape-excluded-major-modes '(emacs-lisp-mode org-mode))
  82     :config
  83     (evil-escape-mode))
  84 #+END_SRC
  85
  86 * Evil-Leader
  87 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
  88   (use-package evil-leader
  89     :ensure t
  90     :config
  91     (global-evil-leader-mode)
  92     (evil-leader/set-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 "e" 'sd/toggle-project-eshell))
 108
 109   (with-eval-after-load "evil"
 110     (evil-define-key 'emacs eshell-mode-map (kbd ";e") 'sd/toggle-project-eshell))
 111
 112 #+END_SRC
 113
 114 * Evil-matchit
 115 [[https://github.com/redguardtoo/evil-matchit]]
 116 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 117   (use-package evil-matchit
 118     :ensure t
 119     :config
 120     (global-evil-matchit-mode 1))
 121 #+END_SRC
 122
 123 * Evil-visualstar
 124 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 125   (use-package evil-visualstar
 126     :ensure t
 127     :init
 128     (setq evil-visualstar/persistent t)
 129     :config
 130     (global-evil-visualstar-mode))
 131 #+END_SRC
 132 * Provide
 133 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
 134   (provide 'init-evil-mode)
 135 #+END_SRC