newbie
/
slot.nvim
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
17 Commits 1 Branch 1 Tag 115 KiB
Lua 100%
Go to file
glepnir f2c0102af8
Merge pull request #1 from jam1015/patch-1 
Update README.md for grammar/clarity
 		2024-05-28 13:48:19 +08:00
.github/workflows update 2023-06-16 16:12:35 +08:00
doc chore(doc): auto generate docs 2023-08-05 08:33:38 +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 README.md 2024-05-27 21:21:48 -04:00
rename.py fix rename.py 2023-08-05 16:33:14 +08: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

Uses busted for testing. Installs by using luarocks --lua-version=5.1 install vusted then runs vusted ./test for your test cases. vusted is a wrapper of Busted especially for testing Neovim plugins.

Create test cases in the test folder. Busted expects files in this directory to be named foo_spec.lua, with _spec as a suffix before the .lua file extension. For more usage details please check busted usage

CI

  • Auto generates doc from README.
  • Runs the Busted/vusted integration tests
  • Lints with stylua.

More

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

License MIT