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 2K
  • Win 686
  • OS X 763
  • Linux 481
Jun 23 Jun 22 Jun 21 Jun 20 Jun 19 Jun 18 Jun 17 Jun 16 Jun 15 Jun 14 Jun 13 Jun 12 Jun 11 Jun 10 Jun 9 Jun 8 Jun 7 Jun 6 Jun 5 Jun 4 Jun 3 Jun 2 Jun 1 May 31 May 30 May 29 May 28 May 27 May 26 May 25 May 24 May 23 May 22 May 21 May 20 May 19 May 18 May 17 May 16 May 15 May 14 May 13 May 12 May 11 May 10 May 9
Windows 1 9 10 15 8 4 5 3 8 10 5 5 3 6 7 6 10 7 9 2 4 9 5 6 9 5 3 6 6 7 12 2 9 4 7 7 8 7 4 5 5 4 8 12 11 5
OS X 1 16 6 11 7 10 8 18 7 7 8 3 4 4 7 12 10 5 10 3 8 11 9 8 5 7 3 4 19 5 5 11 7 4 4 7 6 13 12 10 4 6 8 13 5 5
Linux 2 3 3 2 5 3 1 3 1 4 4 7 1 8 4 5 7 7 4 4 2 5 4 4 12 8 4 5 8 3 7 0 8 12 6 5 4 8 12 3 2 3 6 2 5 6

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).