ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Actual​Vim

by lunixbochs ST3

Sublime Text 3 input mode using Neovim

Labels input, vim

Details

Installs

  • Total 6K
  • Win 2K
  • OS X 3K
  • Linux 2K
Dec 18 Dec 17 Dec 16 Dec 15 Dec 14 Dec 13 Dec 12 Dec 11 Dec 10 Dec 9 Dec 8 Dec 7 Dec 6 Dec 5 Dec 4 Dec 3 Dec 2 Dec 1 Nov 30 Nov 29 Nov 28 Nov 27 Nov 26 Nov 25 Nov 24 Nov 23 Nov 22 Nov 21 Nov 20 Nov 19 Nov 18 Nov 17 Nov 16 Nov 15 Nov 14 Nov 13 Nov 12 Nov 11 Nov 10 Nov 9 Nov 8 Nov 7 Nov 6 Nov 5 Nov 4 Nov 3
Windows 2 7 8 7 7 14 8 7 4 6 13 22 11 11 16 10 9 6 4 17 14 10 5 13 14 5 15 7 15 6 14 9 14 14 17 8 9 5 19 8 11 13 7 12 6 18
OS X 3 14 9 9 9 10 15 6 4 12 13 9 12 17 16 8 10 19 22 22 21 11 18 8 10 8 18 17 25 17 9 20 13 15 12 23 12 9 9 19 16 17 13 6 8 19
Linux 0 9 8 8 7 7 6 8 4 5 5 6 8 5 18 8 7 8 6 8 9 12 6 5 8 6 11 12 8 6 8 8 9 5 11 9 7 9 10 12 8 8 9 8 3 4

Readme

Source
raw.​githubusercontent.​com

ActualVim

Everything you like about using Sublime Text 3, and everything you like about typing in vim.

Actual uses an embedded Neovim instance to accurately manipulate each Sublime Text buffer as though you were editing the text directly in vim, while the Sublime Text interface, features, and plugins continue to work (see end of README for caveats).

This isn't a remote terminal UI like gvim and other vim frontends. Text modification and selections are bidirectionally synced into the actual Sublime Text UI.

Why?

Sublime looks way better than your terminal and has a rich plugin ecosystem.

Other Sublime vim emulation plugins, including the built-in Vintage, are only rough approximations of the functionality of vim itself. They are missing features or behave differently than the real thing.

With ActualVim, you can use your own vimrc, plugins, and any real vim motions/commands, because it is vim behind the scenes, and bidirectional sync means Sublime Text and the native OS interface still works too.

Usage

This plugin requires Neovim to be installed, but should otherwise work on all Sublime Text 3 platforms (tested primarily on Windows and macOS).

Clone ActualVim to the path found in Preferences -> Browse Packages... or sublime.packages_path(). Usually found here:

  • macOS: ~/Library/Application Support/Sublime Text 3/Packages/
  • Linux: ~/.config/sublime-text-3/Packages/
  • Windows: %APPDATA%/Sublime Text 3/Packages/

You can set the Neovim path by opening Preferences: ActualVim Settings using the command palette (cmd+shift+p or ctrl+shift+p) or via Preferences -> Package Settings -> ActualVim Settings.

ActualVim launches a single Neovim embedded instance and multiplexes each Sublime view into a separate buffer.

If the plugin doesn't work (a horizontal underline cursor appears when ActualVim kicks in), check the Sublime Text console for errors and make sure you set the Neovim path. Barring that, file an issue.

Misc

On OS X 10.7+, you should do defaults write com.sublimetext.3 ApplePressAndHoldEnabled -bool false to enable key repeat.

You can run ActualVim: Disable or ActualVim: Enable via the command pallete to toggle the input mode without losing vim state.

Caveats

Currently broken Sublime Features:

  • Multiple Selection (#8).
  • Auto-popups while typing, like completion (#57) and snippet suggestions (#94).
  • Sublime's undo isn't coalesced properly while in vim mode (it's one character at a time: #44).

Surfacing vim's UI (like the status bar) still needs some love, but I have some good ideas for making it look beautiful (better than your terminal) using Sublime's embedded HTML Phantom views.

Extremely large files will see a performance hit until neovim supports change deltas. The large_file_disable command mitigates this by disabling ActualVim for larger files (with configurable cutoff).