A Lua based editor extension API is provided for in-process plugin development.
Installing a Plugin
Plugins are loaded using
visrc.lua configuration file,
leveraging the standard Lua module system. The used runtime paths can be displayed using
:help "Lua paths", the lookup order is also documented in the manual page.
-- load standard vis runtime files, must be done before anything else require('vis') -- load plugin called `<name>` (notice the omission of the `.lua` file extension) require('<name>') -- the remainder of your visrc.lua configuration file
Consider keeping your plugin in a git repo with the name
Consider naming your main script
init.lua, so we are able to
require the containing directory.
Consider cloning or linking your plugin folder to
.config/vis/plugins, so from
visrc.lua you'd call
A few standard plugins are included in the main repository.
Below is a list of externally developed plugins, the quality of which may vary:
- vis-cursors - remember last cursor position per file
- vis-backup - make backups of current files before saving
- vis-fzf-open - open files with fzf
- vis-ctags - add basic ctags support
vis-editorconfig - automatically parse and apply
- vis-commentary - automatic block comments for most languages
- vis-modelines - basic support for Vim modelines
- vis-surround - operators for adding/changing/deleting block delimiters
- vis-pairs - textobjects and motions for delimited blocks
- vis-title - set terminal title to current file
- vis-filetype-settings - set options automatically depending on filetype
- vis-fenced-insert - insert mode as that of traditional vi
- parkour - a simple Paredit
- vis-super-shellout - an alternative way to insert output from arbitrary shell commands
- vis-go - Go development plugin
- vis-fzf-mru - open recently used files with fzf
- vis-quickfix - most of vim's QuickFix commands
<C-w>f, similar to vim's
gxjump to the external link (with custom processor, if required), like in the vim’s netrw.
vis-toggler - improved
- vis-motsel - create selections from motions
- vis-smart-backspace - delete spaces at start of lines, like vim's softtabstop
- vis-plug - an experimental minimal plugin manager for vis
If you have written an extension for vis, you can share it on the list above.