chore(doc): auto generate docs
This commit is contained in:
github-actions[bot]
parent
f2c0102af8
commit
ab08be3530
|
|
@ -1,4 +1,4 @@
|
||||||
*nvim-plugin-template.txt* For NVIM v0.8.0 Last change: 2023 August 05
|
*nvim-plugin-template.txt* For NVIM v0.8.0 Last change: 2024 May 28
|
||||||
|
|
||||||
==============================================================================
|
==============================================================================
|
||||||
Table of Contents *nvim-plugin-template-table-of-contents*
|
Table of Contents *nvim-plugin-template-table-of-contents*
|
||||||
|
|
@ -7,52 +7,57 @@ Table of Contents *nvim-plugin-template-table-of-contents*
|
||||||
- Usage |nvim-plugin-template-nvim-plugin-template-usage|
|
- Usage |nvim-plugin-template-nvim-plugin-template-usage|
|
||||||
- Format |nvim-plugin-template-nvim-plugin-template-format|
|
- Format |nvim-plugin-template-nvim-plugin-template-format|
|
||||||
- Test |nvim-plugin-template-nvim-plugin-template-test|
|
- Test |nvim-plugin-template-nvim-plugin-template-test|
|
||||||
- Ci |nvim-plugin-template-nvim-plugin-template-ci|
|
- CI |nvim-plugin-template-nvim-plugin-template-ci|
|
||||||
- More |nvim-plugin-template-nvim-plugin-template-more|
|
- More |nvim-plugin-template-nvim-plugin-template-more|
|
||||||
- License MIT |nvim-plugin-template-nvim-plugin-template-license-mit|
|
- License MIT |nvim-plugin-template-nvim-plugin-template-license-mit|
|
||||||
|
|
||||||
==============================================================================
|
==============================================================================
|
||||||
1. nvim-plugin-template *nvim-plugin-template-nvim-plugin-template*
|
1. nvim-plugin-template *nvim-plugin-template-nvim-plugin-template*
|
||||||
|
|
||||||
neovim plugin template integration test and doc publish
|
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*
|
USAGE *nvim-plugin-template-nvim-plugin-template-usage*
|
||||||
|
|
||||||
1. click `use this template` button generate a repo on your github.
|
1. Click `use this template` button generate a repo on your github.
|
||||||
2. clone your plugin repo.open terminal then cd plugin directory.
|
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 `pluing-name`.
|
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
|
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 first look at this
|
`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.
|
||||||
template I suggest you look at them first. after these step the `rename.py` will also auto
|
|
||||||
remove.
|
|
||||||
|
|
||||||
now you have a clean plugin env. enjoy!
|
Now you have a clean plugin environment. Enjoy!
|
||||||
|
|
||||||
|
|
||||||
FORMAT *nvim-plugin-template-nvim-plugin-template-format*
|
FORMAT *nvim-plugin-template-nvim-plugin-template-format*
|
||||||
|
|
||||||
format use `stylua` and provide `.stylua.toml`.
|
The CI uses `stylua` to format the code; customize the formatting by editing
|
||||||
|
`.stylua.toml`.
|
||||||
|
|
||||||
|
|
||||||
TEST *nvim-plugin-template-nvim-plugin-template-test*
|
TEST *nvim-plugin-template-nvim-plugin-template-test*
|
||||||
|
|
||||||
use vusted for test install by using `luarocks --lua-version=5.1 install
|
Uses busted <https://lunarmodules.github.io/busted/> for testing. Installs by
|
||||||
vusted` then run `vusted test` for your test cases.
|
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 case in test folder file rule is `foo_spec.lua` with `_spec` more
|
Create test cases in the `test` folder. Busted expects files in this directory
|
||||||
usage please check busted usage <https://lunarmodules.github.io/busted/>
|
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*
|
CI *nvim-plugin-template-nvim-plugin-template-ci*
|
||||||
|
|
||||||
Ci support auto generate doc from README and integration test and lint check by
|
- Auto generates doc from README.
|
||||||
`stylua`.
|
- Runs the Busted/vusted integration tests
|
||||||
|
- Lints with `stylua`.
|
||||||
|
|
||||||
|
|
||||||
MORE *nvim-plugin-template-nvim-plugin-template-more*
|
MORE *nvim-plugin-template-nvim-plugin-template-more*
|
||||||
|
|
||||||
Other usage you can look at my plugins
|
To see this template in action, take a look at my other plugins.
|
||||||
|
|
||||||
|
|
||||||
LICENSE MIT *nvim-plugin-template-nvim-plugin-template-license-mit*
|
LICENSE MIT *nvim-plugin-template-nvim-plugin-template-license-mit*
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue