» Spacemacs-like keybindings for Visual Studio Code

This repository contains a configuration for VSCodeVim that tries to mimic Spacemacs key bindings in VSCode. There is nothing to install but two configuration files to merge in your settings. See Installation for more details.

This project tries to mimic Spacemacs key bindings in VSCode.

Heavy Spacemacs users have trained their muscle memory around the mnemonic key bindings that Spacemacs provides, and usually they start missing them when using other text editors. The goal of this project is to provide a configuration that maps Spacemacs key bindings to VSCode functionalities. This will allow users to continue using their muscle memory and and the mnemonics they know in VSCode.

It is not possible to replicate the full Spacemacs experience within VScode, but it is at least possible to map some key bindings to functions offering the same features as Spacemacs does. For instance, SPC g s in Spacemacs opens git version control through Magit, so it make sense to map it to open the "Source Control" view in VScode. A list of the currently remapped key bindings is available in the Keybindings section.

The Installation can currently not be automated as it requires manual interventions, and updates have also to be resolved manually. This project is young and the direction it should take is not really clear yet. This is discussed in this issue. Feel free to participate in this discussion if you have insightful ideas.

Author

Fabien Dubosson

License

MIT (See LICENSE)

First you will have to install VSCodeVim in order to make VSCode vim-compliant. To do so, press Ctrl + P, enter ext install vscodevim and then press Return. You can then press the Install button, wait for it to finish, and then Reload the editor by clicking the associated button.

To set up VSpaceCode, simply merge the content of the settings.json file with your own settings. To do so, press Ctrl + Shift + P, enter user settings and then press Return:

• If you don't have any VSCodeVim configuration yet, you can simply copy/paste the content of settings.json (without the top-level brackets) somewhere into your settings.json.
• If you already have some VSCodeVim configurations, you will have to manually copy/paste the parts of settings.json into the corresponding vim.normalModeKeyBindings section of your settings.json.

In any case it is recommended to keep the configurations you take from here grouped in your settings.json so you can easily update them by just copy/pasting the relevant parts.

To enable Ctrl + h, Ctrl + j, Ctrl + k, Ctrl + l bindings to navigate in some widgets outside the editor, merge the content of keybindings.json into your keybindings.json.

On Mac, you will need to change the setting for <leader> f f from:

"command": "workbench.action.files.openFile"

to:

"command": "workbench.action.files.openFileFolder"

The following keybindings are configured in the editor through VSCodeVim:

The following keybindings are configured globally in VSCode in some modes:

The key bindings work only when you are inside the code. For example, if you are inside the file explorer window they don't work. Press Ctrl + 1 to focus the first editor group and you will be able to use spacemacs key bindings again.

Contributions are welcome. Spacemacs has more than one thousand key bindings and it is very probably that the contributors of this project are not using them all. Feel free to open pull requests if you have some interesting mappings that do not exist yet. Please try to make the following changes in a single commit:

• Keep bindings sorted in settings.json
• Add the corresponding line in the Keybindings section of this README
• Include your name in the Contributors section of this README

If you are writing and testing some keybindings, and find the changes required to update settings.json too large, you can use npm run dev to compile a ./scripts/settings.json file which is a copy of ./settings.json but with a shorter syntax. Note: npm install should be run the first time to install the dependencies.

In order to see all available VSCode commands press SPC h d and mouse over the command name.

Thanks to the following people for sharing their configurations and contributing to this project:

• adrianstaniec
• CodeFalling
• danielpa9708
• emmanueltouzery
• fabrik42
• jamrizzi
• JJWJ
• joefiorini
• JuanCaicedo
• li-xinyang
• MarcoIeni
• ossoso
• Raphael-Duchaine
• thanhvg
• wabilin

• Intellimacs - Spacemacs' like key bindings for IntelliJ platform.
• Spaceclipse - Spacemacs' like key bindings for Eclipse.