https://github.com/aioutecism/amVim-for-VSCode

The Vim mode for Visual Studio Code(vscode) that works as expected.
https://github.com/aioutecism/amVim-for-VSCode

extension keybindings vim vscode

Last synced: 11 days ago
JSON representation

The Vim mode for Visual Studio Code(vscode) that works as expected.

• Host: GitHub
• URL: https://github.com/aioutecism/amVim-for-VSCode
• Owner: aioutecism
• Created: 2015-12-01T07:58:00.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-06-20T15:40:00.000Z (5 months ago)
• Last Synced: 2024-07-31T20:50:50.904Z (3 months ago)
• Topics: extension, keybindings, vim, vscode
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items/auiworks.amvim
• Size: 1.3 MB
• Stars: 454
• Watchers: 12
• Forks: 42
• Open Issues: 44
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# amVim for VS Code

![icon](images/icon.png)

The [Vim](http://www.vim.org/) mode for [Visual Studio Code](https://code.visualstudio.com/) that works as expected.

## Key features

- Vim style keybindings & looks

- Normal, Visual and Visual Line modes support

- Multi-cursor support

- Works with VS Code's default behaviors

## Not supported

- `:` started commands: Only a few are supported now.

- Visual Block mode: Please use multi-cursor instead for now.

- Custom keybindings: On the roadmap.

## Commands

Check the list [here](https://github.com/aioutecism/amVim-for-VSCode/issues/1).

## Configuration

You can override default configurations in

[User and Workspace Settings](https://code.visualstudio.com/docs/getstarted/settings).

#### `amVim.bindCtrlCommands`

`Boolean`, Default: `true`

Set to `false` to disable `Ctrl+` keybindings.

#### `amVim.mimicVimSearchBehavior`

`Boolean`, Default: `true`

Set to `false` to keep VSCode's keybinding when searching.

#### `amVim.startInInsertMode`

`Boolean`, Default: `false`

Set to `true` to start in Insert mode when opening files.

#### `amVim.smartRelativeLineNumbers`

`Boolean`, Default: `false`

Set to `true` to will make line numbers relative when not in Insert mode.

#### `amVim.useSystemClipboard`

`Boolean`, Default: `false`

Set to `true` to copy to and paste from the system clipboard.

#### `amVim.vimStyleNavigationInListView`

`Boolean`, Default: `true`

Set to `false` to disable Vim style navigation in sidebar.

## Contexts

You can make use of 

[when clause contexts](https://code.visualstudio.com/api/references/when-clause-contexts)

to construct keybindings that only apply in specific scenarios.

#### `amVim.mode`

`String`, Possible values: `NORMAL`, `INSERT`, `VISUAL`, `VISUAL LINE`

Tracks the current editing mode. For backward compatibility, `REPLACE` mode will appear as `INSERT`.

#### `amVim.waitingForInput`

`Boolean`

Set to `true` when amVim is waiting for further input to match a command, otherwise `false`.

This can be used to set up keybindings that perform a custom function when keys are pressed

independently, without overriding the default Vim style behavior for those keys when

prefixed.

For example, the following configuration will redefine Vim style navigation keys `j` and `k`

to move the native cursor, stepping over folded code and stepping into wrapped lines, while

still allowing longer Vim commands like `3j` to work as expected:

```json

[

  {

    "key": "j",

    "command": "cursorDown",

    "when": "editorTextFocus && amVim.mode == 'NORMAL' && !amVim.waitingForInput"

  },

  {

    "key": "k",

    "command": "cursorUp",

    "when": "editorTextFocus && amVim.mode == 'NORMAL' && !amVim.waitingForInput"

  }

]

```

## Contributing

Feel free to open [issues][] to report bugs or require features.

[Pull requests][] are welcomed too! See VS Code's official instructions about:

- [Extension API][]

- [Testing Extensions][]

  - Protip: change `suite(` to `suite.only(` in a test file to run only a

    single test suite at a time. This saves quite a lot of time. Remember to

    remove the `.only` part before making a Git commit.

[issues]: https://github.com/aioutecism/amVim-for-VSCode/issues

[Pull requests]: https://github.com/aioutecism/amVim-for-VSCode/pulls

[Extension API]: https://code.visualstudio.com/api

[Testing Extensions]: https://code.visualstudio.com/api/working-with-extensions/testing-extension