143 lines
5.2 KiB
Markdown
143 lines
5.2 KiB
Markdown
|
[](https://travis-ci.org/VSCodeVim/Vim) [](https://vscodevim-slackin.azurewebsites.net)
|
||
|
|
|
||
|
|
# Vim
|
||
|
|
|
||
|
|
VSCodeVim is a [Visual Studio Code](https://code.visualstudio.com/) extension that provides Vim keybindings within Visual Studio Code.
|
||
|
|
|
||
|
|
Please **[report missing or buggy features on GitHub](https://github.com/VSCodeVim/Vim/issues)**.
|
||
|
|
|
||
|
|
We've added a lot of functionality, but everyone uses Vim in their own special way, so let us know if we're missing your favorite obscure command. :wink:
|
||
|
|
|
||
|
|
We're super friendly people if you want to drop by and talk to us on our [Slack channel](https://vscodevim-slackin.azurewebsites.net)!
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Features We Support
|
||
|
|
|
||
|
|
* All modes (including visual block mode!)
|
||
|
|
* Most typical commands, including command combinations like `c3w`, `daw`, `2dd`, etc. (Check the [roadmap](https://github.com/VSCodeVim/Vim/blob/master/ROADMAP.md) for details.)
|
||
|
|
* Command remapping (jj to esc)
|
||
|
|
* Repeating actions with `.`
|
||
|
|
* Incremental search with `/` and `?` that works like Vim (doesn't just open the search box!)
|
||
|
|
* Correct undo/redo state
|
||
|
|
* Marks
|
||
|
|
* Vim Options
|
||
|
|
|
||
|
|
## Roadmap
|
||
|
|
|
||
|
|
See our [Github Milestone page](https://github.com/VSCodeVim/Vim/milestones) for an idea of what we plan to implement next.
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
1. Within Visual Studio Code, open the command palette (`Ctrl-Shift-P` / `Cmd-Shift-P`)
|
||
|
|
2. Select `Install Extension` and search for 'vim' *or* run `ext install vim`
|
||
|
|
|
||
|
|
## Configure
|
||
|
|
|
||
|
|
Due to overlap between VSCode and VIm, options are loaded slightly different from native Vim. The option loading sequence/priority is
|
||
|
|
|
||
|
|
1. `:set {option}` on the fly
|
||
|
|
2. [TODO] .vimrc.
|
||
|
|
3. `vim.{option}` from user settings or workspace settings.
|
||
|
|
4. VSCode configuration
|
||
|
|
5. VSCodeVim flavored Vim option default values
|
||
|
|
|
||
|
|
### Supported Options
|
||
|
|
|
||
|
|
Vim options can be added to your user or workspace settings (open Command Pallete and search for "User Settings" or "Workspace Settings"). Changes require restarting of VSCode to take effect.
|
||
|
|
|
||
|
|
The following is a subset of the supported configurations; the full list is described in [package.json](https://github.com/VSCodeVim/Vim/blob/master/package.json#L155):
|
||
|
|
|
||
|
|
* insertModeKeyBindings/otherModesKeyBindings
|
||
|
|
* Keybinding overrides to use for insert and other (non-insert) modes
|
||
|
|
* *Example:* Bind `jj` to `<Esc>` while in insert mode
|
||
|
|
|
||
|
|
```
|
||
|
|
"vim.insertModeKeyBindings": [
|
||
|
|
{
|
||
|
|
"before": ["j", "j"],
|
||
|
|
"after": ["<Esc>"]
|
||
|
|
}
|
||
|
|
]
|
||
|
|
```
|
||
|
|
|
||
|
|
Similarly for `otherModesKeyBindings`, bind `jj` to `<Esc>` for modes which are not insert mode
|
||
|
|
|
||
|
|
```
|
||
|
|
"vim.otherModesKeyBindings": [
|
||
|
|
{
|
||
|
|
"before": ["j", "j"],
|
||
|
|
"after": ["<Esc>"]
|
||
|
|
}
|
||
|
|
]
|
||
|
|
```
|
||
|
|
|
||
|
|
* 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/otherModesKeyBindingNonRecursive.
|
||
|
|
|
||
|
|
```
|
||
|
|
"vim.otherModesKeyBindingsNonRecursive": [
|
||
|
|
{
|
||
|
|
"before": ["j"],
|
||
|
|
"after": ["g", "j"]
|
||
|
|
}]
|
||
|
|
```
|
||
|
|
|
||
|
|
* useCtrlKeys
|
||
|
|
* Enable Vim ctrl keys thus overriding common VSCode operations (eg. copy, paste, find, etc). Setting this option to true will enable:
|
||
|
|
* `ctrl+c`, `ctrl+[` => `<Esc>`
|
||
|
|
* `ctrl+f` => Page Forward
|
||
|
|
* `ctrl+v` => Visual Block Mode
|
||
|
|
* etc.
|
||
|
|
* Type: Boolean (Default: `false`)
|
||
|
|
* Example:
|
||
|
|
|
||
|
|
```
|
||
|
|
"vim.useCtrlKeys": true
|
||
|
|
```
|
||
|
|
|
||
|
|
* useSystemClipboard
|
||
|
|
* Enable yanking to the system clipboard by default
|
||
|
|
* Type: Boolean (Default: `false`)
|
||
|
|
|
||
|
|
* useSolidBlockCursor
|
||
|
|
* Use a non-blinking block cursor
|
||
|
|
* Type: Boolean (Default: `false`)
|
||
|
|
|
||
|
|
* ignorecase
|
||
|
|
* Ignore case in search patterns
|
||
|
|
* Type: Boolean (Default: `true`)
|
||
|
|
|
||
|
|
* smartcase
|
||
|
|
* Override the 'ignorecase' option if the search pattern contains upper case characters
|
||
|
|
* Type: Boolean (Default: `true`)
|
||
|
|
|
||
|
|
* hlsearch
|
||
|
|
* When there is a previous search pattern, highlight all its matches
|
||
|
|
* Type: Boolean (Default: `true`)
|
||
|
|
|
||
|
|
## F.A.Q.
|
||
|
|
|
||
|
|
#### `j`, `k` and others don't repeat when I hold them down.
|
||
|
|
|
||
|
|
On OS X, open Terminal and run the following command:
|
||
|
|
|
||
|
|
```
|
||
|
|
defaults write com.microsoft.VSCode ApplePressAndHoldEnabled -bool false
|
||
|
|
```
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
This project is maintained by a group of awesome [contributors](https://github.com/VSCodeVim/Vim/graphs/contributors) and contributions are extremely welcome :heart:. If you are having trouble thinking of how you can help, check out our [roadmap](https://github.com/VSCodeVim/Vim/blob/master/ROADMAP.md).
|
||
|
|
|
||
|
|
For a quick tutorial on how to get started, see our [contributing guide](https://github.com/VSCodeVim/Vim/blob/master/.github/CONTRIBUTING.md).
|
||
|
|
|
||
|
|
## Changelog
|
||
|
|
|
||
|
|
Please see our [list of recent releases and features added.](https://github.com/VSCodeVim/Vim/releases)
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
MIT, see [License](https://github.com/VSCodeVim/Vim/blob/master/LICENSE) for more information.
|