51 lines
2.0 KiB
Plaintext
51 lines
2.0 KiB
Plaintext
*nvim-plugin-template.txt* For NVIM v0.8.0 Last change: 2023 June 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|
|
|
- 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 integration test and doc publish
|
|
|
|
|
|
USAGE *nvim-plugin-template-nvim-plugin-template-usage*
|
|
|
|
click `use this template` button generate a repo on your github. then clone
|
|
your plugin repo.open terminal then cd plugin directory , run `python3
|
|
rename.py your-plugin-name` this will replace all `nvim-plugin-template` to
|
|
your `pluing-name`. Then develope your plugin. Enjoy!
|
|
|
|
|
|
TEST *nvim-plugin-template-nvim-plugin-template-test*
|
|
|
|
use vusted for test install by using `luarocks --lua-version=5.1 install
|
|
vusted` then run `vusted test` for your test cases.
|
|
|
|
create test case in test folder file rule is `foo_spec.lua` with `_spec` more
|
|
usage please check busted usage <https://lunarmodules.github.io/busted/>
|
|
|
|
|
|
CI *nvim-plugin-template-nvim-plugin-template-ci*
|
|
|
|
Ci support auto generate doc from README and integration test.
|
|
|
|
|
|
MORE *nvim-plugin-template-nvim-plugin-template-more*
|
|
|
|
Other usage you can look at my 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:
|