diff --git a/.busted b/.busted new file mode 100644 index 0000000..f4945a0 --- /dev/null +++ b/.busted @@ -0,0 +1,13 @@ +return { + _all = { + coverage = false, + lpath = 'lua/?.lua;lua/?/init.lua', + lua = 'nlua', + }, + default = { + verbose = true, + }, + tests = { + verbose = true, + }, +} diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 3763577..33c27d4 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -23,7 +23,7 @@ jobs: - name: panvimdoc uses: kdheepak/panvimdoc@main with: - vimdoc: guard.nvim + vimdoc: nvim-plugin-template.nvim treesitter: true - uses: stefanzweifel/git-auto-commit-action@v4 with: diff --git a/doc/.gitkeep b/doc/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/doc/nvim-plugin-template.txt b/doc/nvim-plugin-template.txt deleted file mode 100644 index 18735c6..0000000 --- a/doc/nvim-plugin-template.txt +++ /dev/null @@ -1,67 +0,0 @@ -*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 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 - - - -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 - -vim:tw=78:ts=8:noet:ft=help:norl: