Friendly bindings for ZSH's vi mode
Install this plugin with any ZSH plugin manager, or just source it from
your .zshrc.
In INSERT mode (viins keymap), most Emacs key bindings are available. Use
^A and ^E for beginning and end of line, ^R for incremental search,
etc. <Esc> or <C-[> quickly switches into NORMAL mode (vicmd).
ZSH has support for text objects since 5.0.8. This plugin adds the suggested
bindings to use surround-type objects. For example, when in NORMAL mode with
the cursor inside a double-quoted string, type ci" to change the contents
of the string. Or type cs"( to change the quotes to parentheses. Type
ds( to remove the parentheses. Type ys2W] to surround the following two
Words with brackets.
In visual mode, type a[ to select the surrounding bracketed text
(including the brackets), or type i' to select the text within single
quotes. Type S< to put angle brackets around the selected text.
Change the color and shape of the terminal cursor with:
MODE_CURSOR_VICMD="green block"
MODE_CURSOR_VIINS="#20d08a blinking bar"
MODE_CURSOR_SEARCH="#ff00ff steady underline"
Use X11 color names or #RRGGBB notation for colors. The recognized
style words are steady, blinking, block, underline and bar.
If your cursor used to blink, and now it's stopped, you can fix that
with unset MODE_CURSOR_DEFAULT. The default (steady) is
appropriate for most terminals.
If you are using tmux but $TMUX is not set (e.g., you're running
zsh on a remote host), you may need to set TMUX_PASSTHROUGH=1 to
get the cursor styling to work.
If RPS1 / RPROMPT is not set, the mode indicator will be added automatically. The appearance can be set with:
MODE_INDICATOR_VIINS='%F{15}<%F{8}INSERT<%f'
MODE_INDICATOR_VICMD='%F{10}<%F{2}NORMAL<%f'
MODE_INDICATOR_REPLACE='%F{9}<%F{1}REPLACE<%f'
MODE_INDICATOR_SEARCH='%F{13}<%F{5}SEARCH<%f'
MODE_INDICATOR_VISUAL='%F{12}<%F{4}VISUAL<%f'
MODE_INDICATOR_VLINE='%F{12}<%F{4}V-LINE<%f'If you want to add this to your existing RPS1, there are two ways. If
setopt prompt_subst is on, then simply add ${MODE_INDICATOR_PROMPT}
to your RPS1, ensuring it is quoted:
setopt PROMPT_SUBST
# Note the single quotes
RPS1='${MODE_INDICATOR_PROMPT} ${vcs_info_msg_0_}'If you do not want to use prompt_subst, then it must not be quoted, and this module must be loaded first before adding it to your prompt:
setopt NO_prompt_subst
# Load this plugin first, then later on ...
MODE_INDICATOR_VICMD='%F{9}<%F{1}<<%f'
MODE_INDICATOR_SEARCH='%F{13}<%F{5}<<%f'
# Note the double quotes
RPS1="${MODE_INDICATOR_PROMPT} %B%F{15}<%b %*"Each time the line editor keymap changes, the text of the prompt will be substituted, removing the previous mode indicator text and inserting the new.
If your theme sets $MODE_INDICATOR, it will be used as a default
for MODE_INDICATOR_VICMD if nothing else is set.
The $VIM_MODE_KEYMAP variable is set to viins, vicmd or isearch,
for easy inspection from other plugins.
If you find this doesn't work with your terminal, your plugins, your settings or your version of ZSH, please open an issue. If it clobbers some setting that it shouldn't, please file a report.
Some of this code is mangled together from blogs, mailing lists, random repositories, and other plugins. If you have any licensing concerns, please open an issue so it can be addressed. That being said, to the extent possible:
This code is released under the MIT license.