https://github.com/nvimdev/nvim-plugin-template
neovim plugin template integration test and doc publish
https://github.com/nvimdev/nvim-plugin-template
Last synced: 9 months ago
JSON representation
neovim plugin template integration test and doc publish
- Host: GitHub
- URL: https://github.com/nvimdev/nvim-plugin-template
- Owner: nvimdev
- License: mit
- Created: 2023-06-16T07:04:42.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-12T03:32:26.000Z (11 months ago)
- Last Synced: 2025-04-02T06:50:02.939Z (9 months ago)
- Language: Python
- Size: 27.3 KB
- Stars: 73
- Watchers: 3
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/nvim-neorocks/nvim-busted-action?tab=readme-ov-file#running-tests-locally)
## 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
To see this template in action, take a look at my other plugins.
## License MIT