MCPcopy
hub / github.com/VSCodeVim/Vim

github.com/VSCodeVim/Vim @v1.32.4 sqlite

repository ↗ · DeepWiki ↗ · release v1.32.4 ↗
2,895 symbols 6,511 edges 279 files 203 documented · 7%
README

VSCodeVim

Vim emulation for Visual Studio Code

VSCodeVim is a Vim emulator for Visual Studio Code.

  • 📃 Our change log outlines the breaking/major/minor updates between releases.
  • Report missing features/bugs on GitHub.

Table of Contents (click to expand)

💾 Installation

VSCodeVim can be installed via the VS Code Marketplace or the OpenVSX Marketplace.

Mac

To enable key-repeating, execute the following in your Terminal, log out and back in, and then restart VS Code:

defaults write com.microsoft.VSCode ApplePressAndHoldEnabled -bool false              # For VS Code
defaults write com.microsoft.VSCodeInsiders ApplePressAndHoldEnabled -bool false      # For VS Code Insider
defaults write com.vscodium ApplePressAndHoldEnabled -bool false                      # For VS Codium
defaults write com.microsoft.VSCodeExploration ApplePressAndHoldEnabled -bool false   # For VS Codium Exploration users
defaults write com.exafunction.windsurf ApplePressAndHoldEnabled -bool false          # For Windsurf
defaults delete -g ApplePressAndHoldEnabled                                           # If necessary, reset global default

We also recommend increasing Key Repeat and Delay Until Repeat settings in System Settings/Preferences -> Keyboard.

Windows

Like real vim, VSCodeVim will take over your control keys. This behavior can be adjusted with the useCtrlKeys and handleKeys settings.

⚙️ Settings

The settings documented here are a subset of the supported settings; the full list is described in the FEATURES -> Settings tab of VSCodeVim's extension details page, which can be found in the extensions view of VS Code.

Quick Example

Below is an example of a settings.json file with settings relevant to VSCodeVim:

{
  "vim.easymotion": true,
  "vim.incsearch": true,
  "vim.useSystemClipboard": true,
  "vim.useCtrlKeys": true,
  "vim.hlsearch": true,
  "vim.insertModeKeyBindings": [
    {
      "before": ["j", "j"],
      "after": ["<Esc>"]
    }
  ],
  "vim.normalModeKeyBindingsNonRecursive": [
    {
      "before": ["<leader>", "d"],
      "after": ["d", "d"]
    },
    {
      "before": ["<C-n>"],
      "commands": [":nohl"]
    },
    {
      "before": ["K"],
      "commands": ["lineBreakInsert"],
      "silent": true
    }
  ],
  "vim.leader": "<space>",
  "vim.handleKeys": {
    "<C-a>": false,
    "<C-f>": false
  },
  // To improve performance
  "extensions.experimental.affinity": {
    "vscodevim.vim": 1
  }
}

VSCodeVim settings

These settings are specific to VSCodeVim.

Setting Description Type Default Value
vim.changeWordIncludesWhitespace Include trailing whitespace when changing word. This configures the cw action to act consistently as its siblings (yw and dw) instead of acting as ce. Boolean false
vim.cursorStylePerMode.{Mode} Configure a specific cursor style for {Mode}. Omitted modes will use default cursor type Supported cursors: line, block, underline, line-thin, block-outline, and underline-thin. String None
vim.digraphs.{shorthand} Set custom digraph shorthands that can override the default ones. Entries should map a two-character shorthand to a descriptive string and one or more UTF16 code points. Example: "R!": ["🚀", [55357, 56960]] Object {"R!": ["🚀", [0xD83D, 0xDE80]]
vim.disableExtension Disable VSCodeVim extension. This setting can also be toggled using toggleVim command in the Command Palette Boolean false
vim.handleKeys Delegate configured keys to be handled by VS Code instead of by the VSCodeVim extension. Any key in keybindings section of the package.json that has a vim.use<C-...> in the when argument can be delegated back to VS Code by setting "<C-...>": false. Example: to use ctrl+f for find (native VS Code behavior): "vim.handleKeys": { "<C-f>": false }. String "<C-d>": true

"<C-s>": false

"<C-z>": false | | vim.overrideCopy | Override VS Code's copy command with our own, which works correctly with VSCodeVim. If cmd-c/ctrl-c is giving you issues, set this to false and complain here. | Boolean | false | | vim.useSystemClipboard | Use the system clipboard register (*) as the default register | Boolean | false | | vim.searchHighlightColor | Background color of non-current search matches | String | findMatchHighlightBackground ThemeColor | | vim.searchHighlightTextColor | Foreground color of non-current search matches | String | None | | vim.searchMatchColor | Background color of current search match | String | findMatchBackground ThemeColor | | vim.searchMatchTextColor | Foreground color of current search match | String | None | | vim.substitutionColor | Background color of substitution text when vim.inccommand is enabled | String | "#50f01080" | | vim.substitutionTextColor | Foreground color of substitution text when vim.inccommand is enabled | String | None | | vim.startInInsertMode | Start in Insert mode instead of Normal Mode | Boolean | false | | vim.us

Extension points exported contracts — how you extend this code

IBaseCommand (Interface)
(no doc) [143 implementers]
src/actions/types.d.ts
IModeHandlerMap (Interface)
(no doc) [7 implementers]
src/mode/modeHandler.ts
IBaseMovement (Interface)
(no doc) [19 implementers]
src/state/vimState.ts
IConfigurationValidator (Interface)
(no doc) [8 implementers]
src/configuration/iconfigurationValidator.ts
Path (Interface)
* A interface to the path in the node.js.
src/util/path.ts
IModeHandler (Interface)
(no doc) [2 implementers]
src/transformations/execute.ts
ICodeKeybinding (Interface)
(no doc)
extensionBase.ts
ITestObject (Interface)
(no doc)
test/testSimplifier.ts

Core symbols most depended-on inside this repo

newTest
called by 1761
test/testSimplifier.ts
handleMultipleKeyEvents
called by 425
src/transformations/execute.ts
int
called by 393
src/vimscript/expression/build.ts
str
called by 122
src/vimscript/expression/build.ts
assertEqualLines
called by 114
test/testUtils.ts
join
called by 107
src/util/path.ts
get
called by 105
src/mode/modeHandler.ts
handleKeyEvent
called by 99
src/transformations/execute.ts

Shape

Method 1,299
Class 1,150
Function 347
Interface 79
Enum 20

Languages

TypeScript100%

Modules by API surface

src/actions/motion.ts257 symbols
src/actions/commands/actions.ts167 symbols
src/actions/commands/insert.ts108 symbols
src/error.ts103 symbols
src/actions/operator.ts91 symbols
src/actions/plugins/easymotion/registerMoveActions.ts73 symbols
src/actions/commands/window.ts72 symbols
src/actions/commands/commandLine.ts72 symbols
src/history/historyTracker.ts63 symbols
src/textobject/textobject.ts53 symbols
src/actions/plugins/surround.ts50 symbols
src/common/motion/position.ts45 symbols

Dependencies from manifests, versioned

@types/diff-match-patch1.0.36 · 1×
@types/lodash4.17.17 · 1×
@types/mocha10.0.10 · 1×
@types/node22.19.1 · 1×
@types/parsimmon1.10.9 · 1×
@types/sinon17.0.4 · 1×
@types/vscode1.74.0 · 1×
@typescript-eslint/eslint-plugin8.0.0 · 1×
@typescript-eslint/parser8.0.0 · 1×
@vscode/test-electron2.5.2 · 1×
@vscode/vsce3.6.2 · 1×
circular-dependency-plugin5.2.2 · 1×

For agents

$ claude mcp add Vim \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact