ellisonleao/nvim-plugin-template

github

externalboilerplate

225

3

4

12

CREATED

2022-02-14

UPDATED

3 months ago

---

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 for:
  • running tests using plenary.nvim and busted
  • check for formatting errors (Stylua)
  • vimdocs autogeneration from README.md file
  • luarocks release (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