newbie
/
slot.nvim
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
27 Commits 1 Branch 1 Tag 115 KiB
Lua 100%
Go to file
github-actions[bot] a029d3a982 chore(doc): auto generate docs 2025-01-19 11:59:22 +00:00
.github/workflows update CI 2025-01-19 19:58:59 +08:00
doc chore(doc): auto generate docs 2025-01-19 11:59:22 +00:00
lua/nvim-plugin-template improve script and add example codes 2023-06-18 14:38:43 +08:00
plugin update 2023-06-16 16:10:41 +08:00
test improve script and add example codes 2023-06-18 14:38:43 +08:00
.stylua.toml update 2023-06-16 16:10:41 +08:00
LICENSE Initial commit 2023-06-16 15:04:43 +08:00
README.md update CI 2025-01-19 19:58:59 +08:00
rename.py Corrects plugin/ removal in rename.py 2024-12-15 17:45:58 -06:00

README.md

nvim-plugin-template

Neovim plugin template; includes automatic documentation generation from README, integration tests with Busted, and linting with Stylua

Usage

  1. Click use this template button generate a repo on your github.
  2. Clone your plugin repo. Open terminal then cd plugin directory.
  3. Run python3 rename.py your-plugin-name. This will replace all nvim-plugin-template to your plugin-name. Then it will prompt you input y or n to remove example codes in init.lua and test/plugin_spec.lua. If you are familiar this repo just input y. If you are looking at this template for the first time I suggest you inspect the contents. After this step rename.py will also auto-remove.

Now you have a clean plugin environment. Enjoy!

Format

The CI uses stylua to format the code; customize the formatting by editing .stylua.toml.

Test

See Running tests locally

CI

  • Auto generates doc from README.
  • Runs the nvim-busted-action for test.
  • Lints with stylua.

More

To see this template in action, take a look at my other plugins.

License MIT