summaryrefslogtreecommitdiff
path: root/evil-collection.el
blob: 1e4972afb258453603a32b4bf018a77eb7cdcd52 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
;;; evil-collection.el --- A set of keybindings for Evil mode -*- lexical-binding: t -*-

;; Copyright (C) 2017 James Nguyen

;; Author: James Nguyen <james@jojojames.com>
;; Pierre Neidhardt <ambrevar@gmail.com>
;; Maintainer: James Nguyen <james@jojojames.com>
;; Pierre Neidhardt <ambrevar@gmail.com>
;; URL: https://github.com/jojojames/evil-collection
;; Version: 0.0.1
;; Package-Requires: ((emacs "25.1") (evil "1.2.13"))
;; Keywords: evil, tools

;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with this program.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:
;; A set of keybindings for Evil mode.
;;
;; If you want to use Evil in the minibuffer, you'll have to enable it by
;; setting `evil-collection-setup-minibuffer' to t before loading this package.
;; This is so because many users find it confusing.

;;; Code:
(defgroup evil-collection nil
  "A set of keybindings for Evil mode"
  :group 'evil)

(defcustom evil-collection-mode-list
  `((ag t)
    (alchemist t)
    (anaconda-mode t)
    (arc-mode t)
    (bookmark t)
    (calendar t)
    (cider t)
    (comint t)
    (company t)
    (compile t)
    (custom t)
    (cus-theme t)
    (debbugs t)
    (debug t)
    (diff-mode t)
    (dired t)
    (doc-view t)
    (edebug t)
    (elfeed t)
    (elisp-mode t)
    (elisp-refs t)
    (emms t)
    (eshell t)
    (eval-sexp-fu t)
    (flycheck t)
    (geiser t)
    (ggtags t)
    (help t)
    (helm t)
    (ibuffer t)
    (image t)
    (image+ t)
    (info t)
    (ivy t)
    (macrostep t)
    (man t)
    (minibuffer nil)
    ;; occur is in replace.el which was built-in before Emacs 26.
    (occur ,(if (<= emacs-major-version 25) "replace" 'replace))
    (outline t)
    (p4 t)
    (package-menu package)
    (pass t)
    (pdf pdf-view)
    (proced t)
    (prodigy t)
    (profiler t)
    (rtags t)
    (slime t)
    (term t ansi-term multi-term)
    (tide t)
    (transmission t)
    (vlf t)
    (woman t)
    (xref t)
    (ztree ztree-diff))
  "The alist of modes which will be evilified by `evil-collection-init'.
 The values are list of target modes.  If t, then the target
name is the same as the key.

By default, `minibuffer' is not activated by default because many
users find this confusing.  It can be activated with

  (setcar (alist-get 'minibuffer evil-collection-mode-list) t)"
  :type '(alist)
  :group 'evil-collection)

;;;###autoload
(defun evil-collection-init ()
  "Register the Evil bindings for all modes in `evil-collection-mode-list'.

Alternatively, you may register select bindings manually, for
instance:

  (with-eval-after-load 'calendar
    (require 'evil-collection-calendar)
    (evil-collection-calendar-setup))"
  (interactive)
  (dolist (mode evil-collection-mode-list)
    (let ((name (car mode))
          (reqs (cdr mode)))
      (dolist (req reqs)
        (when (eq req t)
          (setq req name))
        (with-eval-after-load req
          (require (intern (concat "evil-collection-" (symbol-name name))))
          (funcall (intern (concat "evil-collection-" (symbol-name name) "-setup"))))))))

(provide 'evil-collection)
;;; evil-collection.el ends here