re-construct evil config
[dotfiles.git] / 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 #+END_SRC
39
40 ** Initial mode and state config
41 - Use =normal= as the default state but exclude some special modes.
42 - Bind =[escape]=  to =normal= mode. This only works on GUI Emacs. If need to work on Terminal, shoudl also bind =(kbd
43   "<ESC>)=, but this will make the combined key =M-= not wor.
44 - Not alias =insert= state to =emacs= state, as it break some vi's feature in insert mode, such as column edit. Instead,
45   here add a advice function to change the sate as emacs when enter insert mode, but this is only limited in some
46   certain modes.
47 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
48   (defvar my-mode-list-to-use-emacs-as-insert '(emacs-lisp-mode org-mode eshell-mode lisp-interaction-mode)
49     "The mode in this list will consider insert state as emacs state by adding `advice-add' below.")
50
51   (defvar my-modes-use-emacs-init '(emacs-lisp-mode org-mode lisp-interaction-mode eshell-mode text-mode)
52     "The mode in this list will use emacs sate as a initial evil state.")
53
54   (with-eval-after-load "evil"
55     (setq evil-default-state 'normal)
56       ;; (defalias 'evil-inset-mode 'evil-emacs-state)
57     (define-key evil-emacs-state-map [escape] 'evil-normal-state)
58     ;; (define-key evil-emacs-state-map (kbd "<ESC>") 'evil-normal-state)
59     (dolist (mode my-modes-use-emacs-init) (evil-set-initial-state mode 'emacs))
60     (advice-add 'evil-insert-state :after (lambda (&optional arg)
61                                             (when (memq major-mode my-mode-list-to-use-emacs-as-insert)
62                                               (evil-emacs-state)))))
63 #+END_SRC
64
65 * Evil-escape
66 [[https://github.com/syl20bnr/evil-escape][evil-escape]], escape from anything with customizable key sequence.
67 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
68   (use-package evil-escape
69     :ensure t
70     :init
71     (setq-default evil-escape-delay 0.2)
72     (setq-default evil-escape-key-sequence "jj")
73     (setq-default evil-escape-excluded-states '(normal visual motion emacs))
74     (setq-default evil-escape-excluded-major-modes '(emacs-lisp-mode org-mode))
75     :config
76     (evil-escape-mode))
77 #+END_SRC
78
79 * Evil-Leader
80 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
81   (use-package evil-leader
82     :ensure t
83     :config
84     (global-evil-leader-mode)
85     (evil-leader/set-leader ";")
86     ;; Buffer & File
87     (evil-leader/set-key "f" 'ido-switch-buffer)
88     (evil-leader/set-key "w" 'evil-save)
89     (evil-leader/set-key "r" 'ivy-recentf)
90     (evil-leader/set-key "w" 'save-buffer)
91     (evil-leader/set-key "e" 'evil-edit)
92     (evil-leader/set-key "o" 'ido-find-file)
93     (evil-leader/set-key "p" 'projectile-find-file)
94     ;; Window
95     (evil-leader/set-key "s" 'evil-window-split)
96     (evil-leader/set-key "v" 'evil-window-vsplit)
97     (evil-leader/set-key "q" 'evil-quit)
98     ;; others
99     (evil-leader/set-key "h" 'help)
100     (evil-leader/set-key "h" 'help))
101
102 #+END_SRC
103
104 * Evil-match
105 [[https://github.com/redguardtoo/evil-matchit]]
106 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
107   (use-package evil-matchit
108     :ensure t
109     :config
110     (global-evil-leader-mode 1))
111 #+END_SRC
112
113 * Evil-visualstar
114 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
115   (use-package evil-visualstar
116     :ensure t
117     :init
118     (setq evil-visualstar/persistent t)
119     :config
120     (global-evil-visualstar-mode))
121 #+END_SRC
122 * Provide 
123 #+BEGIN_SRC emacs-lisp :tangle yes :results silent
124   (provide 'init-evil-mode)
125 #+END_SRC