mlsteele / evil-escape

Customizable key sequence to escape from insert state and everything else in Emacs.

evil-escape

Table of Contents

• evil-escape
  • Install
  • Usage
  • Customization
    • Key sequence
    • Delay between keys
  • Limitations
    • Macro
    • First key

Customizable key sequence to escape from insert state and everything else in Emacs.

Press quickly fd (or the 2-keys sequence of your choice) to:

• escape from all stock evil states to normal state
• escape from evil-lisp-state to normal state
• escape from evil-iedit-state to normal state
• abort evil ex command
• quit minibuffer
• abort isearch
• quit magit buffers
• quit help buffers
• quit apropos buffers
• quit ert buffers
• quit undo-tree buffer
• quit paradox
• quit gist-list menu
• quit helm-ag-edit
• hide neotree buffer

And more to come !

Contributions to support more buffers are very welcome: Escape Everything !

Install

The package will be available soon in MELPA.

If you have MELPA in package-archives, use

M-x package-install RET evil-escape RET

If you don't, open evil-escape.el in Emacs and call package-install-from-buffer.

Usage

To toggle the evil-escape mode globally:

M-x evil-escape-mode

Customization

Key sequence

The key sequence can be customized with the variable evil-escape-key-sequence. For instance to change it for jk:

(setq-default evil-escape-key-sequence "jk")

Note: The variable evil-escape-key-sequence must be set before requiring evil-escape.

Delay between keys

The delay between the two key presses can be customized with the variable evil-escape-delay. The default value is 0.1. If your key sequence is composed with the two same characters it is recommended to set the delay to 0.2.

(setq-default evil-escape-delay 0.2)

Note: The variable evil-escape-delay must be set before requiring evil-escape.

Excluding a major mode

A major mode can be excluded by adding it to the list evil-escape-excluded-major-modes.

Limitations

Macro

fd cannot be used during macro recording, use regular ESC instead.

First key

Due to the current implementation only the following characters can be used as the first character of the key sequence:

Keys
b
B
e
E
f
F
G
h
H
j
k
l
K
L
M
n
N
t
T
w
W
{
}
#
%
`
'
(
)
*
,
/
;
?
^
+
_
-