A Neovim Plugin Template
A template repository for Neovim plugins.
Using it
Via gh
:
$ gh repo create my-plugin -p ellisonleao/nvim-plugin-template
Via github web page:
Click on Use this template
Features and structure
- 100% Lua
- Github actions to run tests and check for formatting errors (Stylua)
- Tests created with busted + plenary.nvim
- luarocks release support (LUAROCKS_API_KEY secret configuration required)
Plugin structure
.
โโโ lua
โย ย โโโ plugin_name
โย ย โย ย โโโ module.lua
โย ย โโโ plugin_name.lua
โโโ Makefile
โโโ plugin
โย ย โโโ plugin_name.lua
โโโ README.md
โโโ tests
โย ย โโโ minimal_init.lua
โย ย โโโ plugin_name
โย ย โโโ plugin_name_spec.lua