VimMode.spoon

🚀 This library will add Vim motions and operators to all your input fields on OS X. Why should Emacs users have all the fun? Not all motions or operators are implemented, but I tried to at least hit the major ones I use day-to-day!

My goal was to make this library fairly easy to drop in, even if you aren't currently running Hammerspoon. I welcome any PRs or additions to extend the motions and/or operators that are supported.

This is my first Lua library, so things might be a little weird :)

Progress

Motions

• shift + a - jump to end of line
• shift + g - jump to last line of input
• shift + i - jump to beginning of line
• 0 - beginning of line
• $ - end of line
• b - back by word
• f<char> - jump to next instance of <char> - requires context we don't have
• F<char> - jump to prev instance of <char> - requires context we don't have
• t<char> - jump to before next instance of <char> - requires context we don't have
• T<char> - jump to before prev instance of <char> - requires context we don't have
• w fwd by word
• hjkl - arrow keys

Operators

• shift + c - delete to end of line, exit normal mode
• shift + d delete to end of line
• c - delete and exit normal mode
• d - delete
• cc - delete line and enter insert mode
• dd - delete line
• r<char> to replace - currently broken
• x to delete char under cursor

Other

• i to go back to insert mode
• o - add new line below, exit normal mode
• shift + o - add new line above, exit normal mode
• p to paste
• s to delete under cursor, exit normal mode
• u to undo
• ctrl + r to redo
• y to yank to clipboard
• / to trigger cmd+f search
• visual mode with v
• support prefixing commands with numbers to repeat them (e.g. 2dw)

Usage

• To enter normal mode, hit whichever key you bind to it (typically jj, jk, or hyper)
• The screen should slightly dim when you enter normal mode.
• To exit normal mode, press i - business as usual.

Prerequisites

• Install Hammerspoon

Installation

Run this in your Terminal:

mkdir -p ~/.hammerspoon/Spoons
git clone https://github.com/dbalatero/VimMode.spoon \
  ~/.hammerspoon/Spoons/VimMode.spoon

Modify your ~/.hammerspoon/init.lua file to contain the following:

vim = hs.loadSpoon('VimMode')

-- Basic key binding to ctrl+;
-- You can choose any key binding you want here, see:
--   https://www.hammerspoon.org/docs/hs.hotkey.html#bind

hs.hotkey.bind({'ctrl'}, ';', function()
  vim:enter()
end)

Binding jk to enter Vim Mode

vim = hs.loadSpoon('VimMode')

vim:enableKeySequence('j', 'k')

You can also use modifiers in this sequence:

-- requires shift to be held down when you type jk
vim:enableKeySequence('j', 'k', {'shift'})

Disabling vim mode for certain apps

You probably want to disable this Vim mode in the terminal, or any actual instance of Vim. Calling vim:disableForApp(...) allows you to disable or enable Vim mode depending on which window is in focus.

vim = hs.loadSpoon('VimMode')

-- sometimes you need to check Activity Monitor to get the app's
-- real name
vim:disableForApp('Code')
vim:disableForApp('iTerm')
vim:disableForApp('MacVim')
vim:disableForApp('Terminal')