martanne / vis

A vi-like editor based on Plan 9's structural regular expressions
Other
4.25k stars 257 forks source link

Plugins conventions ( suggestions for Wiki ) #802

Closed erf closed 4 years ago

erf commented 4 years ago

I had a few suggestions for plugin conventions i'd thought i might add to the wiki page, but i though i might get some feedback first. Here we go:

Plugin Conventions

Consider keeping your plugin in a git repo with the name vis-<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 require 'plugins/my_plugin.

erf commented 4 years ago

I'll just add them now. Feel free to change / delete them or comment here if you have any other suggestions.