61 lines
2.6 KiB
Plaintext
61 lines
2.6 KiB
Plaintext
*nvim-plugin-template.nvim.txt* For NVIM v0.8.0 Last change: 2025 February 12
|
|
|
|
==============================================================================
|
|
Table of Contents *nvim-plugin-template.nvim-table-of-contents*
|
|
|
|
1. nvim-plugin-template |nvim-plugin-template.nvim-nvim-plugin-template|
|
|
- Usage |nvim-plugin-template.nvim-nvim-plugin-template-usage|
|
|
- Format |nvim-plugin-template.nvim-nvim-plugin-template-format|
|
|
- Test |nvim-plugin-template.nvim-nvim-plugin-template-test|
|
|
- CI |nvim-plugin-template.nvim-nvim-plugin-template-ci|
|
|
- More |nvim-plugin-template.nvim-nvim-plugin-template-more|
|
|
- License MIT |nvim-plugin-template.nvim-nvim-plugin-template-license-mit|
|
|
|
|
==============================================================================
|
|
1. nvim-plugin-template *nvim-plugin-template.nvim-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-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-nvim-plugin-template-format*
|
|
|
|
The CI uses `stylua` to format the code; customize the formatting by editing
|
|
`.stylua.toml`.
|
|
|
|
|
|
TEST *nvim-plugin-template.nvim-nvim-plugin-template-test*
|
|
|
|
See Running tests locally
|
|
<https://github.com/nvim-neorocks/nvim-busted-action?tab=readme-ov-file#running-tests-locally>
|
|
|
|
|
|
CI *nvim-plugin-template.nvim-nvim-plugin-template-ci*
|
|
|
|
- Auto generates doc from README.
|
|
- Runs the nvim-busted-action <https://github.com/nvim-neorocks/nvim-busted-action> for test.
|
|
- Lints with `stylua`.
|
|
|
|
|
|
MORE *nvim-plugin-template.nvim-nvim-plugin-template-more*
|
|
|
|
To see this template in action, take a look at my other plugins.
|
|
|
|
|
|
LICENSE MIT *nvim-plugin-template.nvim-nvim-plugin-template-license-mit*
|
|
|
|
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
|
|
|
|
vim:tw=78:ts=8:noet:ft=help:norl:
|