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 296
  • Win 114
  • OS X 111
  • Linux 71
Mar 26 Mar 25 Mar 24 Mar 23 Mar 22 Mar 21 Mar 20 Mar 19 Mar 18 Mar 17 Mar 16 Mar 15 Mar 14 Mar 13 Mar 12 Mar 11 Mar 10 Mar 9 Mar 8 Mar 7 Mar 6 Mar 5 Mar 4 Mar 3 Mar 2 Mar 1 Feb 28 Feb 27 Feb 26 Feb 25 Feb 24 Feb 23 Feb 22 Feb 21 Feb 20 Feb 19 Feb 18 Feb 17 Feb 16 Feb 15 Feb 14 Feb 13 Feb 12 Feb 11 Feb 10
Windows 4 5 6 10 8 5 13 4 5 15 5 9 11 11 7 4 5 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
OS X 3 8 11 16 13 12 4 4 3 18 8 7 5 3 11 5 10 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Linux 7 4 10 10 2 7 3 3 4 7 8 4 4 4 1 3 5 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

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, without breaking any Sublime Text features (aside from multiple selection for now).

This isn't a remote terminal UI like gvim and other vim frontends. Text modification and selections are bidirectionally synced. You can still use the entire native Sublime interface, including plugins.

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

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.

Multiple selection is a work-in-progress, because it needs vim plugin support.

There are several minor bugs, and it may very rarely freeze due to the inability to tell if a command will block Neovim or not. Some bugs are waiting on Neovim upstream, but they have been very responsive thus far.

Extremely large files might see a performance hit because the entire buffer is synced after each command. This needs to be optimized, but neovim's msgpack rpc is fairly fast so it hasn't been a bottleneck yet.