Vi (Vim) editing mode

Note: Here functionalities in the branch support-vi-mode is explained. These functionalities are not yet in master.

Enabling vi/vim editing mode

Vi/vim editing mode will be enabled by one of the following settings.

With a inputrc setting

In ~/.inputrc

$if Bash

  set editing-mode vi

$endif

With set -o vi in ~/.bashrc

Another way is to use set -o vi in ~/.bashrc.

if [[ $- == *i* ]]; then # in interactive session
  set -o vi
fi

With bind in ~/.bashrc

Or, the following setting also enables the vi/vim mode.

if [[ $- == *i* ]]; then # in interactive session
  bind 'set editing-mode vi'
fi

With ble.sh setting in ~/.bashrc

After the load of the ble.sh, the following setting also enables the vi/vim mode. This setting overwrites all the other settings presented so far, i.e., settings like set -o emacs, etc. will be overwritten.

if [[ $- == *i* ]]; then # in interactive session

  # ... after the load of ble.sh ...

  bleopt default_keymap=vi
fi

Possible preferences

Mode name for the normal mode

In vi/vim mode mode names are shown for each name, such as -- INSERT -- (for insert mode) or ~ (for normal mode). The mode name for the normal mode can be change by keymap_vi_normal_mode_name option:

bleopt keymap_vi_normal_mode_name:=$'\e[1m-- NORMAL --\e[m'

If you don't want to show a mode name in the normal mode, please add the following instead:

bleopt keymap_vi_normal_mode_name:=

(Insert mode) SP: magic-space / insert space

The default mapping of SP is magic-space which performs history expansion before inserting a space. If you want to have just a space without history expansion, please add the following setting.

ble-bind -m vi_insert -f 'SP' 'self-insert'

(Insert mode) C-k: kill-forward-line / digraphs

The default mapping of C-k is vi-insert/@norepeat kill-forward-line. If you want to input digraphs with <C-k>{char1}{char2}, please add the following setting:

ble-bind -m vi_insert -f 'C-k' 'vi-insert/insert-digraph'

(Insert mode) C-o: single-command-mode / accept-and-next

The default mapping of C-o is vi-insert/single-command-mode. If you want to execute the command and load the next history entry with C-o, please add the following setting:

ble-bind -m vi_insert -f 'C-o' 'vi-insert/@norepeat accept-and-next'

Or you may like C-@, instead of C-o, bound to accept-and-next:

ble-bind -m vi_insert -f 'C-@' 'vi-insert/@norepeat accept-and-next'

surround.vim

Some of functionalities are imported from github.com:tpope/vim-surround. To use them add the following line after loading ble.sh:

source "$_ble_base/lib/vim-surround.sh"

Currently only ys, yss, cs, ds are supported, yet HTML/XML tags are not supported. Commands yS, ySS are to be implemented soon.

The implementation vim-surround.sh supports configurable replacements used by ys and cs with bleopt variables. The following codes show example configuration.

bleopt vim_surround_45:=$'$( \r )' # for ysiw-
bleopt vim_surround_61:=$'$(( \r ))' # for ysiw=
bleopt vim_surround_q:=\' # for ysiwq
bleopt vim_surround_Q:=\" # for ysiwQ