Skip to content

Latest commit

 

History

History
198 lines (170 loc) · 10.3 KB

README.org

File metadata and controls

198 lines (170 loc) · 10.3 KB

feature/evil

Table of Contents

Description

This holy module brings the vim experience to Emacs.

Module Flags

  • +everywhere Enables evilified keybinds everywhere possible. Uses the evil-collection plugin as a foundation.

Plugins

Hacks

  • The o/O keys will respect and continue commented lines (can be disabled by setting +evil-want-o/O-to-continue-comments to nil).
  • In visual mode, * and # will search for the current selection instead of the word-at-point.
  • The :g[lobal] ex command has been modified to highlight matches.
  • More of vim’s filename modifiers are supported in ex commands (like :p, :p:h or :t) than vanilla evil-mode offers.
  • A custom filename modifier is available in Doom: :P, which expands to the project root (throws an error if not in a project).

Prerequisites

This module has no external prerequisites.

Features

Ported vim plugins

The following vim plugins have been ported to evil:

Vim PluginEmacs PluginKeybind(s)
vim-commentaryevil-nerd-commenteromap gc
vim-easymotionevil-easymotionomap gs
vim-lionevil-lionomap gl / gL
vim-seek or vim-sneakevil-snipemmap s / S, omap z / Z & x / X
vim-surroundevil-embrace and evil-surroundvmap S, omap ys
vim-unimpaired(provided by Doom)see the list

This module has also ported vim-unimpaired keybinds to Emacs.

In other modules:

  • The tools/neotree & tools/treemacs modules provide a NERDTree equivalent.
  • The editor/multiple-cursors module contains functionality equal to the following vim plugins:
    • evil-multiedit => vim-multiedit
    • evil-mc => vim-multiple-cursors

Custom Text Objects

This module provides a couple extra text objects, along with the built-in ones. For posterity, here are the built-in ones:

  • w W words
  • s sentences
  • p paragraphs
  • b parenthesized blocks
  • b ( ) { } [ ] < > braces, parentheses and brackets
  • ' " ` quotes
  • t tags
  • o symbols

And these are text objects added by this module:

  • a C-style function arguments (provided by evil-args)
  • B any block delimited by braces, parentheses or brackets (provided by evil-textobj-anyblock)
  • c Comments
  • f For functions (but relies on the major mode to have sane definitions for beginning-of-defun-function and end-of-defun-function)
  • g The entire buffer
  • i j k by indentation (k includes one line above; j includes one line above and below) (provided by evil-indent-plus)
  • x XML attributes (provided by exato)

Custom Ex Commands

Ex CommandDescription
:@Apply macro on selected lines
:al[ign][!] REGEXPAlign text to the first match of REGEXP. If BANG, align all matches on each line
:cp[!] NEWPATHCopy the current file to NEWPATH
:dash QUERYLook up QUERY (or the symbol at point) in dash docsets
:dehtml [INPUT]HTML decode selected text / inserts result if INPUT is given
:enhtml [INPUT]HTML encode selected text / inserts result if INPUT is given
:iedit REGEXPInvoke iedit on all matches for REGEXP
:k[ill]all[!]Kill all buffers (if BANG, affect buffer across workspaces)
:k[ill]bKill all buried buffers
:k[ill]m[!] REGEXPKill buffers whose name matches REGEXP (if BANG, affect buffers across workspaces)
:k[ill]oKill all other buffers besides the selected one
:k[ill]Kill the current buffer
:lo[okup] QUERYLook up QUERY on an online search engine
:mc REGEXPInvoke multiple cursors on all matches for REGEXP
:mv[!] NEWPATHMove the current file to NEWPATH
:na[rrow]Narrow the buffer to the selection
:padOpen a scratch pad for running code quickly
:ral[ign][!] REGEXPRight-Align text that matches REGEXP. If BANG, align all matches on each line
:replOpen a REPL and/or copy the current selection to it
:retabConvert indentation to the default within the selection
:rev[erse]Reverse the selected lines
:rm[!] [PATH]Delete the current buffer’s file and buffer
:tcd[!]Send cd X to tmux. X = the project root if BANG, X = default-directory otherwise

Configuration

Removing evil-mode

You must do two things to remove Evil:

  1. Remove :editor evil from ~/.doom.d/init.el,
  2. Run doom sync to clean up lingering dependencies and regenerate your autoloads files.
  3. [OPTIONAL] You may want to assign new values to doom-leader-alt-key and doom-localleader-alt-key. These are bound to C-c and C-c l by default.

Ignore doom-leader-key and doom-localleader-key, they don’t apply to non-evil sessions.

Evil-specific configuration and keybindings (defined with map!) will be ignored without :editor evil present (and omitted when byte-compiling).

Keep in mind that, at the time of this writing, Doom was designed by a vimmer, for vimmers. Little consideration has been put into designing a keybind scheme for vanilla Emacs users (though it’s being worked on!).

That means that much of Doom’s functionality will be orphaned in an evil-less setup. You’ll have to set your own keybinds.

I suggest studying config/default/+emacs-bindings.el to see what keybinds are available for non-evil users. Otherwise, you may find inspiration on the example Doom configurations page.

Restoring old substitution behavior on s/S

Doom replaces the s and S keys with the evil-snipe package (a port of vim-seek/vim-sneak for 2-character versions of f/F/t/T).

To disable evil-snipe on s/S, you can either:

  1. Disable evil-snipe-mode by adding (after! evil-snipe (evil-snipe-mode -1)) to $DOOMDIR/config.el,
  2. Or disable evil-snipe completely with (package! evil-snipe :disable t) added to $DOOMDIR/packages.el, but this will also disable incremental highlighting for the f/F/t/T motions keys.
  3. Or use cl and cc, respectively; they do the same thing.

Restoring old Y behavior (yank the whole line)

Doom changes the behavior of the Y key in normal mode to yank-to-EOL (equivalent to y$). This was to make it consistent with the C and D capital operators, and because it was redundant with yy, which is easier to type than y$.

If you prefer the old behavior, it can be reversed with:

;; add to ~/.doom.d/config.el
(setq! evil-want-Y-yank-to-eol nil)

Disabling cursor movement when exiting insert mode

Vim (and evil) move the cursor one character back when exiting insert mode. If you prefer that it didn’t, set:

;; add to ~/.doom.d/config.el
(setq evil-move-cursor-back nil)