Vim: A TypeScript repository from worbunkel

VSCodeVim

Vim emulation for Visual Studio Code

VSCodeVim is a Visual Studio Code extension that enables:

Keybindings and command combinations (c3w, daw, 2dd, etc)
Modes: normal, insert, command-line, visual, visual line, visual block
Command remapping (jj to <Esc>, : to command panel, etc.)
Incremental search with / and ?
Marks
Popular vim plugin features built-in (easymotion, surround, commentary)
Multi-cursor support, run vim commands everywhere!
Refer to our roadmap for a full list

Please report missing features/bugs on GitHub and join us on Slack.

Getting Started
- Mac setup
- Windows setup
Settings
Multi-cursor mode
Emulated plugins
VSCodeVim tricks
F.A.Q / Troubleshooting
Contributing
Release notes

Getting started

VSCodeVim is automatically enabled following installation and the reloading of VSCode.

Vim compatibility

All common Vim commands are supported. For a detailed list of supported features, refer to our roadmap. Vimscript is not supported, so you aren't able to load your .vimrc or use .vim plugins. You have to replicate these using our Settings and Emulated plugins.

Mac setup

If key repeating isn't working for you, execute this in your Terminal.

defaults write com.microsoft.VSCode ApplePressAndHoldEnabled -bool false         # For VS Code
defaults write com.microsoft.VSCodeInsiders ApplePressAndHoldEnabled -bool false # For VS Code Insider

We also recommend going into System Preferences -> Keyboard and increasing the Key Repeat and Delay Until Repeat settings to improve your speed.

Windows setup

VSCodeVim will take over your control keys, just like real vim, so you get the full vim experience. This behaviour can be adjusted with the useCtrlKeys and handleKeys settings.

Settings

Quick example settings

Below is an example of a settings.json file for VSCode settings applicable to this extension.

{
    "vim.easymotion": true,
    "vim.incsearch": true,
    "vim.useSystemClipboard": true,
    "vim.useCtrlKeys": true,
    "vim.hlsearch": true,
    "vim.insertModeKeyBindings": [
        {
            "before": ["j","j"],
            "after": ["<Esc>"]
        }
    ],
    "vim.otherModesKeyBindingsNonRecursive": [
        {
            "before": ["<leader>","d"],
            "after": ["d", "d"]
        },
        {
            "before":["<C-n>"],
            "after":[],
            "commands": [
                {
                    "command": ":nohl"
                }
            ]
        }
    ],
    "vim.leader": "<space>",
    "vim.handleKeys":{
        "<C-a>": false,
        "<C-f>": false
    }
}

The following is a subset of the supported settings; the full list is described in the Contributions tab in the extensions menu of VSCode.

VSCodeVim settings

These settings are specific to VSCodeVim.

`"vim.startInInsertMode"`

Have VSCodeVim start in Insert Mode rather than Normal Mode.
We would be remiss in our duties as Vim users not to say that you should really be staying in Normal mode as much as you can, but hey, who are we to stop you?

`"vim.overrideCopy"`

Override VSCode's copy command with our own, which works correctly with VSCodeVim.
If cmd-c or ctrl-c is giving you issues, set this to false and complain here.
Type: Boolean (Default: true)

`"vim.useSystemClipboard"`

Enable yanking to the system clipboard by default
Type: Boolean (Default: false)

`"vim.searchHighlightColor"`

Set the color of search highlights.
Type: Color String (Default: rgba(150, 150, 150, 0.3))

`"vim.substituteGlobalFlag"`

Similar to Vim's gdefault setting.
/g flag in a substitute command replaces all occurrences in the line. Without this argument, replacement occurs only for the first occurrence in each line.
When "vim.substituteGlobalFlag" is true, the 'g' is default on. This means that all matches in a line are substituted instead of one. When a 'g' flag is given to a ":substitute" command, this will toggle the substitution of all or one match.

`"vim.useCtrlKeys"`

Enable Vim ctrl keys thus overriding common VSCode operations such as copy, paste, find, etc. Enabling this setting will result in the following keybindings:
- ctrl+c, ctrl+[ => <Esc>
- ctrl+f => Full Page Forward
- ctrl+d => Half Page Back
- ctrl+b => Half Page Forward
- ctrl+v => Visual Block Mode
- etc.
Type: Boolean (Default: true)

`"vim.cmdLineInitialColon"`

Set this to have VSCodeVim mimick Vim, showing the ':' colon character in the Vim command line when it is called.
Type: Boolean (Default: false)

`"vim.handleKeys"`

Delegate certain keybindings to be handled natively by VSCode instead of by the VSCodeVim extension
Complete list of key combinations supported by this setting can be found under the keybindings section of our package.json. Each key that has a vim.use<C-...> in the when argument can be delegated back to vscode by setting "<C-...>": false.
Example: user wants to use ctrl+f for find (native VSCode behaviour), but wants to have useCtrlKeys set to true so that other vim bindings work:

    "vim.handleKeys": {
        "<C-a>": false,
        "<C-f>": false
    }

`"vim.visualstar"`

In visual mode, start a search with * or # using the current selection
Type: Boolean (Default: false)

`"vim.cursorStylePerMode"`

Configure a specific cursor style per mode; omitted modes will use default cursor type
Supported modes: normal, insert, replace, visual, visualline, and visualblock
Supported cursors: line, block, underline, line-thin, block-outline, and underline-thin

    "vim.cursorStylePerMode" : {
        "normal": "underline",
        "insert": "line-thin",
        "replace": "block-outline"
    }

`"vim.disableExtension"`

Disable VSCodeVim (Note: this is different from disabling extension through VSCode)
This setting can be changed through the settings or via toggleVim command in the Command Palette
Type: Boolean (Default: false)

Neovim Integration

⚠️ Experimental feature. Please leave feedback on neovim integration here.

We now have neovim integration for Ex-commands. To enable,

install neovim
add the following configurations:

"vim.enableNeovim": true
"vim.neovimPath": <path to neovim>

Here's some ideas on what you can do with neovim integration:

The power of g
The :normal command
Faster search and replace!

Key remapping

There's several different mechanisms you can use to define custom remappings. Also see the useCtrlKeys and handleKeys settings.

`"vim.insertModeKeyBindings"`/`"vim.otherModesKeyBindings"`

Keybinding overrides to use for insert and other (non-insert) modes.
Bind jj to <Esc> in insert mode:

    "vim.insertModeKeyBindings": [
        {
            "before": ["j", "j"],
            "after": ["<Esc>"]
        }
    ]

Bind : to show the command palette:

"vim.otherModesKeyBindingsNonRecursive": [
    {
        "before": [":"],
        "after": [],
        "commands": [
            {
                "command": "workbench.action.showCommands",
                "args": []
            }
        ]
    }
]

Bind ZZ to save and close the current file:

    "vim.otherModesKeyBindingsNonRecursive": [
        {
            "before": ["Z", "Z"],
            "after": [],
            "commands": [
                {
                    "command": "workbench.action.files.save",
                    "args": []
                },
                {
                    "command": "workbench.action.closeActiveEditor",
                    "args": []
                }
            ]
        }
    ]

Bind ctrl+n to turn off search highlighting and <leader>w to save the current file:

    "vim.otherModesKeyBindingsNonRecursive": [
        {
            "before":["<C-n>"],
            "after":[],
            "commands": [
                {
                    "command": ":nohl",
                    "args": []
                }
            ]
        },
        {
            "before": ["leader", "w"],
            "after": [],
            "commands": [
                {
                    "command": "workbench.action.files.save",
                    "args": []
                }
            ]
        }
    ]

`"vim.insertModeKeyBindingsNonRecursive"`/`"otherModesKeyBindingsNonRecursive"`

Non-recursive keybinding overrides to use for insert and other (non-insert) modes (similar to :noremap)
Example: Bind j to gj. Notice that if you attempted this binding normally, the j in gj would be expanded into gj, on and on forever. Stop this recursive expansion using insertModeKeyBindingsNonRecursive and/or otherModesKeyBindingNonRecursive.

    "vim.otherModesKeyBindingsNonRecursive": [
        {
            "before": ["j"],
            "after": ["g", "j"]
        }
    ]

Status bar color settings

Almost like vim-airline in VSCode!

`"vim.statusBarColorControl"`

⚠️ Experimental feature. Due to VSCode API limitations, this function modifies settings.json in the workspace resulting in latency and a constant changing diff in your working directory (see issue#2124).

Control status bar color based on current mode
Type: Boolean (Default: false)

Once enabled, configure "vim.statusBarColors".

    "vim.statusBarColorControl": true,
    "vim.statusBarColors" : {
        "normal": "#005f5f",
        "insert": "#5f0000",
        "visual": "#5f00af",
        "visualline": "#005f87",
        "visualblock": "#86592d",
        "replace": "#000000"
    }

Vim settings

Configuration settings that have been copied from vim. Vim settings are loaded in the following sequence:

:set {setting}
vim.{setting} from user/workspace settings.
VSCode settings
VSCodeVim default values

`"vim.ignorecase"`

Ignore case in search patterns
Type: Boolean (Default: true)

`"vim.smartcase"`

Override the 'ignorecase' setting if the search pattern contains upper case characters
Type: Boolean (Default: true)

`"vim.hlsearch"`

When there is a previous search pattern, highlight all its matches
Type: Boolean (Default: false)

`"vim.incsearch"`

Show the next search match while you're searching.
Type: Boolean (Default: true)

`"vim.autoindent"`

Copy indent from current line when starting a new line
Type: Boolean (Default: true)

`"vim.timeout"`

Timeout in milliseconds for remapped commands
Type: Number (Default: 1000)

`"vim.showcmd"`

Show the text of any command you are in the middle of writing.
Type: Boolean (Default: true)

`"vim.showmodename"`

Show the name of the current mode in the statusbar.
Type: Boolean (Default: true)

`"vim.textwidth"`

Width to word-wrap to when using gq.
Type: number (Default: 80)

`"vim.leader"`

What key should <leader> map to in key remappings?
Type: string (Default: \)

Multi-Cursor mode

⚠️ Multi-Cursor mode is experimental. Please report issues in our feedback thread.

Entering into multi-cursor mode

Enter multi-cursor mode by:

Pressing cmd-d on OSX.
Running "Add Cursor Above/Below" or the shortcut on any platform.
Pressing gb, a new shortcut we added which is equivalent to cmd-d on OSX or ctrl-d on Windows. (It adds another cursor at the next word that matches the word the cursor is currently on.)

Doing stuff

Now that you have multiple cursors, you should be able to use Vim commands as you see fit. Most should work; some are unsupported (ref PR#587).

Each cursor has its own clipboard.
Pressing Escape in Multi-Cursor Visual Mode will bring you to Multi-Cursor Normal mode. Pressing it again will return you to Normal mode.

Emulated plugins

vim-easymotion

Based on vim-easymotion. To activate easymotion, you need to make sure that easymotion is set to true in settings.json (default is false).

Once easymotion is active, initiate motions using the following commands. After you initiate the motion, text decorators/markers will be displayed and you can press the keys displayed to jump to that position. leader is configurable and is \ by default.

Motion Command	Description
`<leader><leader> s <char>`	Search character
`<leader><leader> f <char>`	Find character forwards
`<leader><leader> F <char>`	Find character backwards
`<leader><leader> t <char>`	Til character forwards
`<leader><leader> T <char>`	Til character backwards
`<leader><leader> w`	Start of word forwards
`<leader><leader> b`	Start of word backwards
`<leader><leader> e`	End of word forwards
`<leader><leader> ge`	End of word backwards
`<leader><leader> j`	Start of line forwards
`<leader><leader> k`	Start of line backwards
`<leader><leader> / <char>... <CR>`	Search n-character
`<leader><leader><leader> bdt`	Til character
`<leader><leader><leader> bdw`	Start of word
`<leader><leader><leader> bde`	End of word
`<leader><leader><leader> bdjk`	Start of line

<leader><leader> (2s|2f|2F|2t|2T) <char><char> and <leader><leader><leader> bd2t <char>char> are also available. The difference is character count required for search. For example, <leader><leader> 2s <char><char> requires two characters, and search by two characters. This mapping is not a standard mapping, so it is recommended to use your custom mapping.

You can customize the appearance of easymotion markers (the boxes with letters) using the following settings:

Setting	Description
`vim.easymotionMarkerBackgroundColor`	The background color of the marker box.
`vim.easymotionMarkerForegroundColorOneChar`	The font color for one-character markers.
`vim.easymotionMarkerForegroundColorTwoChar`	The font color for two-character markers, used to differentiate from one-character markers.
`vim.easymotionMarkerWidthPerChar`	The width in pixels allotted to each character.
`vim.easymotionMarkerHeight`	The height of the marker.
`vim.easymotionMarkerFontFamily`	The font family used for the marker text.
`vim.easymotionMarkerFontSize`	The font size used for the marker text.
`vim.easymotionMarkerFontWeight`	The font weight used for the marker text.
`vim.easymotionMarkerYOffset`	The distance between the top of the marker and the text (will typically need some adjusting if height or font size have been changed).
`vim.easymotionKeys`	The characters used for jump marker name

vim-surround

Based on surround.vim, the plugin is used to work with surrounding characters like parenthesis, brackets, quotes, and XML tags.

t or < as <desired char> or <existing char> will do tags and enter tag entry mode.

Surround is enabled by default, but can be disabled by setting "vim.surround": false.

Surround Command	Description
`d s <existing char>`	Delete existing surround
`c s <existing char> <desired char>`	Change surround existing to desired
`y s <motion> <desired char>`	Surround something with something using motion (as in "you surround")
`S <desired char>`	Surround when in visual modes (surrounds full selection)

Some examples:

"test" with cursor inside quotes type cs"' to end up with 'test'
"test" with cursor inside quotes type ds" to end up with test
"test" with cursor inside quotes type cs"t and enter 123> to end up with <123>test</123>
test with cursor on word test type ysaw) to end up with (test)

vim-commentary

Similar to vim-commentary, but uses the VSCode native "Toggle Line Comment" and "Toggle Block Comment" features.

Usage examples:

gc - toggles line comment. For example gcc to toggle line comment for current line and gc2j to toggle line comments for the current line and the next line.
gC - toggles block comment. For example gCi) to comment out everything within parenthesis.

vim-indent-object

Based on vim-indent-object, it allows for treating blocks of code at the current indentation level as text objects. Useful in languages that don't use braces around statements (e.g. Python).

Provided there is a new line between the opening and closing braces / tag, it can be considered an agnostic cib/ci{/ci[/cit.

Command	Description
`<operator>ii`	This indentation level
`<operator>ai`	This indentation level and the line above (think `if` statements in Python)
`<operator>aI`	This indentation level, the line above, and the line after (think `if` statements in C/C++/Java/etc)

VSCodeVim tricks!

Vim has a lot of nifty tricks and we try to perserve some of them:

gd - jump to definition.
gq - on a visual selection reflow and wordwrap blocks of text, preserving commenting style. Great for formatting documentation comments.
gb - adds another cursor on the next word it finds which is the same as the word under the cursor.
af - visual mode command which selects increasingly large blocks of text. For example, if you had "blah (foo [bar 'ba|z'])" then it would select 'baz' first. If you pressed af again, it'd then select [bar 'baz'], and if you did it a third time it would select "(foo [bar 'baz'])".
gh - equivalent to hovering your mouse over wherever the cursor is. Handy for seeing types and error messages without reaching for the mouse!

F.A.Q.

None of the vim `ctrl` (e.g. `ctrl+f`, `ctrl+v`) commands work

Set the useCtrlKeys setting to true.

Moving `j`/`k` over folds opens up the folds!

Try setting vim.foldfix to true. This is a hack; it works fine, but there are side effects (see issue#22276).

Key repeat doesn't work!

Are you on a Mac? Did you go through our mac-setup instructions?

There are annoying intellisense/notifications/popups that I can't close with `<esc>`! Or I'm in a snippet and I want to close intellisense!

Press shift+<esc> to close all of those boxes.

Contributing

This project is maintained by a group of awesome people and contributions are extremely welcome ❤️. For a quick tutorial on how you can help, see our contributing guide.

Special shoutouts to cool contributors

Thanks to @xconverge for making over 100 commits to the repo. If you're wondering why your least favorite bug packed up and left, it was probably him.
Thanks to @Metamist for implementing EasyMotion!
Thanks to @sectioneight for implementing text objects!
Special props to Kevin Coleman, who created our awesome logo!
Shoutout to @chillee aka Horace He for his contributions and hard work.

worbunkel/Vim

VSCodeVim

Contents

Getting started

Vim compatibility

Mac setup

Windows setup

Settings

Quick example settings

VSCodeVim settings

"vim.startInInsertMode"

"vim.overrideCopy"

"vim.useSystemClipboard"

"vim.searchHighlightColor"

"vim.substituteGlobalFlag"

"vim.useCtrlKeys"

"vim.cmdLineInitialColon"

"vim.handleKeys"

"vim.visualstar"

"vim.cursorStylePerMode"

"vim.disableExtension"