hbcbh1999 / vim-mode Goto Github PK

Vim Mode package

Provides Vim modal control for Atom, blending the best of Vim and Atom.

Current Status

Sizable portions of Vim work as you'd expect, including many complex combinations. Even so, this package is far from finished (Vim wasn't built in a day).

If there's a feature of Vim you're missing, it might just be that you use it more often than other developers. Adding a feature can be quick and easy. Check out the closed pull requests to see examples of community contributions, and look at the issues to see if anyone has already solved your problem.

Installing

Use the Atom package manager, which can be found in the Settings view or run apm install vim-mode from the command line.

Issues and Limitations

If you want the Vim ex line (for :w, :s, etc.), you can try ex-mode which works in conjunction with this plugin.

Currently, vim-mode has some issues with non-US keyboard layouts. If you are using a keyboard layout which isn't American and having problems, try installing keyboard-localization.

Development

• Create a branch with your feature/fix.
• Add a spec (take inspiration from the ones that are already there).
• Create a PR.

When in doubt, open a PR earlier rather than later and join #vim-mode on the Atom Slack so that you can receive feedback from the community. We want to get your fix or feature included as much as you do.

See the contribution guide.