*nvim-plugin-template.txt*    For NVIM v0.8.0    Last change: 2024 December 16

==============================================================================
Table of Contents                     *nvim-plugin-template-table-of-contents*

1. nvim-plugin-template            |nvim-plugin-template-nvim-plugin-template|
  - Usage                    |nvim-plugin-template-nvim-plugin-template-usage|
  - Format                  |nvim-plugin-template-nvim-plugin-template-format|
  - Test                      |nvim-plugin-template-nvim-plugin-template-test|
  - CI                          |nvim-plugin-template-nvim-plugin-template-ci|
  - More                      |nvim-plugin-template-nvim-plugin-template-more|
  - License MIT        |nvim-plugin-template-nvim-plugin-template-license-mit|

==============================================================================
1. nvim-plugin-template            *nvim-plugin-template-nvim-plugin-template*

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


USAGE                        *nvim-plugin-template-nvim-plugin-template-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                      *nvim-plugin-template-nvim-plugin-template-format*

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


TEST                          *nvim-plugin-template-nvim-plugin-template-test*

Uses busted <https://lunarmodules.github.io/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
<https://lunarmodules.github.io/busted/>


CI                              *nvim-plugin-template-nvim-plugin-template-ci*

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


MORE                          *nvim-plugin-template-nvim-plugin-template-more*

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


LICENSE MIT            *nvim-plugin-template-nvim-plugin-template-license-mit*

Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>

vim:tw=78:ts=8:noet:ft=help:norl: