|d9a70ef219||2 weeks ago|
|.github||10 months ago|
|modes||2 weeks ago|
|test||2 years ago|
|.gitignore||5 years ago|
|Cask||2 years ago|
|LICENSE||5 years ago|
|Makefile||1 year ago|
|README.org||2 weeks ago|
|evil-collection.el||3 weeks ago|
|yasnippet_evil-collection||11 months ago|
- Motion (
- Quitting (
- Refreshing / Reverting (
- Selecting / Filtering / Narrowing / Searching
- Go to definition (
- Go to references, etc (
- Go to current entity
- Open thing at point (
- Emacs-style jumping (
- Browse URL (
- Help (
- History browsing (
- REPL (
- Zooming (
- Editable Buffers
- Motion (
- Key Translation
- Third-party packages
- Submitting Issues
https://github.com/emacs-evil/evil-collection/workflows/CI/badge.svg?branch=master">file:https://github.com/emacs-evil/evil-collection/workflows/CI/badge.svg?branch=master " title="file:" /> " title="file:" />
This is a collection of Evil bindings for the parts of Emacs that Evil does
not cover properly by default, such as
M-x calendar, Eshell and
Warning: Expect some default bindings to change in the future.
evil-overriding-mapsis assumed as
nilto reduce redundant
w/W/l/f/tetc evil bindings. See Fixup Info-mode for example.
- Reduce context switching: As soon as "moving around" gets hardwired
<hjkl>, it becomes frustratingly inefficient not to have it everywhere.
- Community work: setting up bindings is tremendous work and joining force can only save hours for all of Evil users out there. While not everyone may agree on the chosen bindings, it helps to have something to start with rather than nothing at all. In the end, users are free to override a subset of the proposed bindings to best fit their needs.
- Consistency: Having all bindings defined in one place allows for enforcing consistency across special modes and coordinating the community work to define a reference implementation.
Get the package, either from MELPA:
M-x package-install RET evil-collection RET
Or clone / download this repository and modify your
(add-to-list 'load-path (expand-file-name "/path/to/evil-collection/" user-emacs-directory))
Register the bindings, either all at once with
or mode-by-mode, for instance:
(with-eval-after-load 'calendar (evil-collection-calendar-setup))
or by providing an argument to
a list can also be provided to
(evil-collection-init '(calendar dired calc ediff))
The list of supported modes is configured by
evil-want-keybinding is set to
evil-want-integration is set to
t before loading
evil-collection. Note some other packages may load evil (e.g. evil-leader) so
bear that in mind when determining when to set the variables.
See https://github.com/emacs-evil/evil-collection/issues/60 and https://github.com/emacs-evil/evil/pull/1087 for more details.
(setq evil-want-integration t) ;; This is optional since it's already set to t by default. (setq evil-want-keybinding nil) (require 'evil) (when (require 'evil-collection nil t) (evil-collection-init))
Here's another full TLDR
(use-package evil :ensure t :init (setq evil-want-integration t) ;; This is optional since it's already set to t by default. (setq evil-want-keybinding nil) :config (evil-mode 1)) (use-package evil-collection :after evil :ensure t :config (evil-collection-init))
NOTE: If you don't like surprises but still want to use
evil-collection-mode-list to nil
and adding each mode manually might be a better option.
evil-collection-mode-list to disable or add any modes that should be
|evil-collection-calendar-want-org-bindings||nil||Set up Org functions in calendar keymap.|
|evil-collection-outline-bind-tab-p||nil||Enable <tab>-based bindings in Outline mode.|
|evil-collection-term-sync-state-and-mode-p||t||Synchronize insert/normal state with char/line-mode in term-mode.|
|evil-collection-setup-minibuffer||nil||Set up Vim style bindings in the minibuffer.|
|evil-collection-setup-debugger-keys||t||Set up debugger keys for certain modes.|
|evil-collection-want-unimpaired-p||t||Set up unimpaired bindings globally.|
|evil-collection-want-find-usages-bindings||t||Bind -find references-, etc to various modes.|
|evil-collection-config||*||List of mode specific configurations.|
|evil-collection-key-whitelist||nil||List of keys Evil Collection is allowed to bind to.|
|evil-collection-key-blacklist||nil||List of keys Evil Collection is not allowed to bind to.|
|evil-collection-state-passlist||nil||List of Evil States Evil Collection is allowed to bind to.|
|evil-collection-state-denylist||nil||List of Evil States Evil Collection is not allowed to bind to.|
For example, if you want to enable Evil in the minibuffer, you'll have to turn
it on explicitly by customizing
minibuffer-related packages such as Helm rely on this option.
(use-package evil-collection :custom (evil-collection-setup-minibuffer t) :init (evil-collection-init))
evil-collection-config can also be modified to configure specific modes.
At the moment, it can be used to defer binding keys to those specific modes
in order to improve startup time.
The following rules serve as guiding principles to define the set of standard Evil bindings for various modes. Since special modes are by definition structurally incomparable, those rules cannot be expected to be applied universally.
The rules are more-or-less sorted by priority.
- Don't bind anything to
Keep the movement keys when possible and sensible.
Keep the yanking and register keys when possible and sensible.
Keep the search keys when possible and sensible.
Keep the mark keys when possible and sensible.
Keep the windowing keys when possible and sensible.
z-prefixed bindings (see below).
The following keys are free when insert state does not make sense in the current mode:
Any of those keys can be set to be a prefix key.
zare the ubiquitous prefix keys.
ggenerally stands for "go" and is best used for movements.
zis used for scrolling, folding, spell-checking and more.
Macro and action keys
Ensure terminal compatibility without sacrificing GUI key bindings.
- Tab key is recognized as
<tab>in GUI and
C-iis bound to jumping forward for vim compatibility. If Shift+Tab is not relevant, just bind
g TABto the function that Tab is bound to. If Shift+Tab is relevant, bind
g TABto the function that Tab is bound to, and bind
g[to the function that Shift+Tab is bound to for terminal compatibility.
- Tab key is recognized as
- Enter key is recognized as
<return>in GUI and
- Bind only
M-RET. Or, bind
M-RETto the same functions
<M-return>are bound to.
S-RETis impossible on terminal. Bind
<S-return>and a vacant key to the same function for terminal compatibility.
- Enter key is recognized as
Many special modes share the same set of similar actions. Those actions should share the same bindings across all modes whenever feasible.
]-prefixed keys for navigation between sections. If the mode makes no difference between the end of a section and the beginning of the next, use
gk: synonym for
]. That's what evil-magit does.
gkrather be synonyms for
C-k? They cannot emulate the behaviour of
C-k: If there is granularity, i.e. subsections, use
C-kto browse them. This reflects evil-magit and evil-mu4e default bindings.
}: If there is no paragraph structure,
}can be used for sub-sectioning.
): If there is no sentence structure,
)can be used for sub-sectioning.
hjklcan be used for atomic movements, but
HJKLcan usually not be used because
Lare all universal (
evil-joinand usually does not make sense in special modes).
C-hshould not be remapped: Since we have
C-kfor vertical motion, it would make sense to use
C-lfor horizontal motion. There are some shortcomings though:
- In Vim,
C-hworks as backspace, but Evil does not follow that behaviour.
- In Emacs, it is a prefix key for all help-related commands, and so is
- Most importantly,
C-his too widespread and ubiquitous to be replaced. So we don't.
- In Vim,
C-l: As a consequence of the former point,
M-<hjkl>: Those keys are usually free in Evil but still bound to their Emacs default (e.g.
downcase-word). Besides, if
C-kare already used, having
M-kmight add up to the confusion.
q is for recording macros. Vim quits with
ZQ. In most
Emacs special modes, it stands for quitting while macros are recorded/played
A good rule of thumb would be:
- Always bind
ZQto the mode specific quitting functions. If there is none,
- If macros don't make sense in current mode, then
Refreshing / Reverting (
gris used for refreshing in evil-magit, evil-mu4e, and some Spacemacs configurations (org-agenda and neotree among others).
C-lis traditionally used to refresh the terminal screen. Since there does not seem to be any existing use of it, we leave the binding free for other uses.
m defaults to
evil-set-marker which might not be very useful in special
' can still be used as it can jump to other buffers.
m: Mark or toggle mark, depending on what the mode offers. In visual mode, always mark. With a numeric argument, toggle mark on that many following lines.
u: Unmark current selection.
U: Unmark all.
~: Toggle all marks. This mirrors the "invert-char" Vim command bound to
M: Mark all, if available. Otherwise use
*: Mark-prefix or mark all if current mode has no prefix.
*is traditionally a wildcard.
%: Mark regexp.
x: Execute action on marks. This mirrors Dired's binding of
* is used for marking, then
# is free.
Also note that Emacs inconsistently uses
U to unmark.
Selecting / Filtering / Narrowing / Searching
Sseem to be used in some places like mu4e.
s: [s]elect/[s]earch/filter candidates according to a pattern.
S: Remove filter and select all.
=is usually free and its significance is obvious. It's taken for zooming though.
|is not free but the pipe symbolic is very tantalizing.
Go to definition (
gd: [g]o to [d]efinition. This is mostly for programming modes. If there's a corresponding 'pop' action, use
Go to references, etc (
evil-collection-want-find-usages-bindings is set to t:
gr: [g] to [r]eferences. This binding is also used for refresh/reverting modes in non programming modes but is usually empty for programming modes.
gA: [g]o to [A]ssignments.
- Additional bindings: There may be additional binds under this category. Please file a Pull Request if so.
Go to current entity
.: go to current entity (day for calendar, playing track for EMMS). Bind only if more relevant than
Open thing at point (
M-RET: Open thing at point in current window, open in other window and display in other window respectively. The latter is like the former with the focus remaining on the current window.
gO: When available, same as
M-RETrespectively. This is useful in terminals where
M-RETmight not work.
Emacs-style jumping (
Browse URL (
gx: go to URL. This is a default Vim binding.
g?: is the standard key for help related commands.
?in places where backward search is not very useful.
History browsing (
C-p are standard bindings to browse the history elements.
If the mode has a Go To REPL-type command, set it to
-have obvious meanings.
0has a somewhat intuitive meaning, plus it is next to
=is useful as a synonym for
+because it is the unshifted key of
When debugging is on, debugger keys takes the most precedence.
These keys will be set when there's an available command for them.
n: Step Over
i: Step Into
o: Step Out
c: Continue/Resume Execution
q: Quit Debugging
H: Continue until Point
e: Evaluate Expression
b: Set Breakpoint
u: Unset Breakpoint
>: Navigate to Next Frame
<: Navigate to Previous Frame
J: Jump to debugger location
For debugging outside of debugger being on (e.g. setting initial breakpoints), we use similar keys to realgud.
For buffers where insert-state doesn't make sense but buffer can be edited,
(e.g. wdired or wgrep), pressing
i will change into editable state.
When this editable state is turned on,
ZQ will abort and clear any changes.
ZZ will finish and save any changes.
ESC will exit editable state.
Modes with commands that can be bound to :q/:wq/etc will have those keys remapped.
evil-collection-translate-key allows binding a key to the definition of
another key in the same keymap (comparable to how Vim's keybindings work). Its
arguments are the
keymaps to bind/look up the key(s) in followed
optionally by keyword arguments (currently only
states should be nil for non-evil keymaps, and both
keymaps can be a single symbol or a list of symbols.
This function can be useful for making key swaps/cycles en masse. For example,
someone who uses an alternate keyboard layout may want to retain the
positions for directional movement in dired, the calendar, etc.
Here's an example for Colemak of making swaps in a single keymap:
(evil-collection-translate-key nil 'evil-motion-state-map ;; colemak hnei is qwerty hjkl "n" "j" "e" "k" "i" "l" ;; add back nei "j" "e" "k" "n" "l" "i")
Here's an example of using
evil-collection-setup-hook to cycle the keys for
all modes in
(defun my-hjkl-rotation (_mode mode-keymaps &rest _rest) (evil-collection-translate-key 'normal mode-keymaps "n" "j" "e" "k" "i" "l" "j" "e" "k" "n" "l" "i")) ;; called after evil-collection makes its keybindings (add-hook 'evil-collection-setup-hook #'my-hjkl-rotation) (evil-collection-init)
A more common use case of
evil-collection-translate-key would be for keeping
the functionality of some keys that users may bind globally. For example,
] are bound in some modes. If you use these keys as global prefix
keys that you never want to be overridden, you'll want to give them higher
priority than other evil keybindings (e.g. those made by
'normal some-map ...)). To do this, you can create an "intercept" map and bind
your prefix keys in it instead of in
(defvar my-intercept-mode-map (make-sparse-keymap) "High precedence keymap.") (define-minor-mode my-intercept-mode "Global minor mode for higher precedence evil keybindings." :global t) (my-intercept-mode) (dolist (state '(normal visual insert)) (evil-make-intercept-map ;; NOTE: This requires an evil version from 2018-03-20 or later (evil-get-auxiliary-keymap my-intercept-mode-map state t t) state)) (evil-define-key 'normal my-intercept-mode-map (kbd "SPC f") 'find-file) ;; ...
You can then define replacement keys:
(defun my-prefix-translations (_mode mode-keymaps &rest _rest) (evil-collection-translate-key 'normal mode-keymaps "C-SPC" "SPC" ;; these need to be unbound first; this needs to be in same statement "[" nil "]" nil "[[" "[" "]]" "]")) (add-hook 'evil-collection-setup-hook #'my-prefix-translations) (evil-collection-init)
By default, the first invocation of
evil-collection-translate-key will make a
backup of the keymap. Each subsequent invocation will look up keys in the backup
instead of the original. This means that a call to
evil-collection-translate-key will always have the same behavior even if
evaluated multiple times. When
:destructive t is specified, keys are looked up
in the keymap as it is currently. This means that a call to
evil-collection-translate-key that swapped two keys would continue to
swap/unswap them with each call. Therefore when
:destructive t is used, all
cycles/swaps must be done within a single call to
evil-collection-translate-key. To make a comparison to Vim keybindings,
:destructive t is comparable to Vim's
:destructive nil is
comparable to Vim's
noremap (where the "original" keybindings are those that
existed in the keymap when
evil-collection-translate-key was first called).
You'll almost always want to use the default behavior (especially in your init
file). The limitation of
:destructive nil is that you can't translate a key to
another key that was defined after the first
:destructive t may be useful for interactive experimentation.
evil-collection-swap-key is also provided as a wrapper around
evil-collection-translate-key that allows swapping keys:
(evil-collection-swap-key nil 'evil-motion-state-map ";" ":") ;; is equivalent to (evil-collection-translate-key nil 'evil-motion-state-map ";" ":" ":" ";")
In some cases, keys are bound through `evil-define-minor-mode-key` and may
need to be translated using
(evil-collection-swap-minor-mode-key '(normal motion) '(evil-snipe-local-mode evil-snipe-override-local-mode) "k" "s" ;; Set this to t to make this swap the keys everytime ;; this expression is evaluated. :destructive nil) (evil-collection-translate-minor-mode-key '(normal motion) '(evil-snipe-local-mode evil-snipe-override-local-mode) "k" "s" "s" "k" ;; Set this to t to make this swap the keys everytime ;; this expression is evaluated. :destructive nil)
Third-party packages are provided by several parties:
|Major mode||Evil bindings|
|lispy||lispyville or evil-lispy|
|org||org-evil or evil-org|
evil-collection has minimal support (
sentence/paragraph forwarding) for
org if you prefer less
Should you know any suitable package not mentioned in this list, let us know and file an issue.
Making SPC work similarly to spacemacs.
evil-collection binds over SPC in many packages. To use SPC as a leader key
with the general library:
(use-package general :ensure t :init (setq general-override-states '(insert emacs hybrid normal visual motion operator replace)) :config (general-define-key :states '(normal visual motion) :keymaps 'override "SPC" 'hydra-space/body)) ;; Replace 'hydra-space/body with your leader function.
See noctuid's evil guide for other approaches.
- Unintialized mode maps in
evil-collection-setup-hookis ran with a list of keymaps passed into it. Some misconfigured modes may not have yet initialized their keymap at this time so the value of the variable may be nil. In that case, an alternative is to use a mode-hook to do any custom settings.
(add-hook 'evil-collection-setup-hook (lambda (_mode keymaps) (add-hook 'ediff-mode-hook (lambda () (... keymaps ...)))))
View 196 for more info.
Don't allow Evil-Collection to bind some keys.
;; Don't allow Evil Collection to bind to gfu and gfp. (setq evil-collection-key-blacklist '("gfu" "gfp"))
Modes left behind
Some modes might still remain unsupported by this package. Should you be missing
<hjkl>, please feel free to do a pull request.
Writing a new binding
This yasnippet template can be used to bootstrap a new binding.
For example, if we were to want to add
evil-collection support to
(e.g.) There is a package that contains:
Create a directory named eldoc under modes/. Create a file
named evil-collection-eldoc.el under the newly created eldoc directory. Then use
the above template as an example or, using yasnippet,
yas-expand the above template which will result in something like below:
;;; evil-collection-eldoc.el --- Bindings for `eldoc' -*- lexical-binding: t -*- ;; Copyright (C) 2022 James Nguyen ;; Author: James Nguyen <email@example.com> ;; Maintainer: James Nguyen <firstname.lastname@example.org> ;; URL: https://github.com/emacs-evil/evil-collection ;; Version: 0.0.2 ;; Package-Requires: ((emacs "27.1")) ;; Keywords: evil, emacs, convenience, 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: ;;; Bindings for eldoc. ;;; Code: (require 'evil-collection) (require 'eldoc nil t) (defvar eldoc-mode-map) (defconst evil-collection-eldoc-maps '(eldoc-mode-map)) (defun evil-collection-eldoc-setup () "Set up `evil' bindings for eldoc." (evil-collection-define-key 'normal 'eldoc-mode-map )) (provide 'evil-collection-eldoc) ;;; evil-collection-eldoc.el ends here
(defvar evil-collection--supported-modes `( ;; ... eldoc ;; ... ) "List of modes supported by evil-collection. Elements are either target mode symbols or lists which `car' is the mode symbol and `cdr' the packages to register.")
When reproducing issues, you can use this emacs -Q recipe.
(setq user-emacs-directory "~/.emacs.1.d") (setq package-user-dir (format "%s/elpa/%s/" user-emacs-directory emacs-major-version)) (setq package-enable-at-startup nil package-archives '(("melpa" . "https://melpa.org/packages/") ("gnu" . "http://elpa.gnu.org/packages/"))) (require 'package) (package-initialize) (unless (package-installed-p 'use-package) (package-refresh-contents) (package-install 'use-package)) (require 'use-package) (setq use-package-always-ensure t) (use-package evil :ensure t :init (setq evil-want-keybinding nil) :config (evil-mode 1)) (use-package evil-collection :after evil :ensure t :config (evil-collection-init))
We welcome any additional modes that are not already supported.
All bindings in
evil-collection are open to change so if there's a better or
more consistent binding, please
open an issue or
submit a pull request.
Follow The Emacs Lisp Style Guide for coding conventions.
Erlang/OTP has a good read for helpful commit messages.