Vim/README.md
Mark Rendle 5c1218785b Update README.md
Added step to run tsd install to Contributing section.
2015-11-30 10:31:14 +00:00

1.9 KiB

Build Status Build status Slack Status

Vim

Vim emulation for Visual Studio Code.

Screenshot

Installation and Usage

  1. Install Visual Studio Code
  2. In the command palette (Ctrl-Shift-P or Cmd-Shift-P) select Install Extension and search for vim. Alternatively, run ext install vim

Project Status

Completed

  • Modes:

    • Visual: v, V
    • Command: Esc, Ctrl+[
    • Insert: i, I, a, A, o, O
    • Current Mode displayed in the status bar in the bottom left
  • Commands:

    • Command Palette: :
    • Navigation: h, j, k, l
    • Indentation: >>, <<
    • Deletion: dd, dw, db
    • Editing: u, ctrl+r
    • File Operations: :q, :w

Planned

In no particular order:

  • Search: /
  • Support Macros
  • Buffers
  • Neovim Integration

Contributions

Contributions are extremely welcomed! Take a look at Extension API on how to get started and our current issues to see what we are working on next.

Getting started

  1. Install Visual Studio Code.
  2. Fork the repo.
  3. Run npm install to install all the dependencies.
  4. Run tsd install to install type definitions (using tsd).
  5. Create a topic branch.
  6. Run tests:
    • Ensure tslint passes by running: gulp
    • Ensure tests pass by running extension tests within Visual Studio Code
  7. Squash your commits.
  8. Submit your PR

License

MIT