docs(vimdoc): Auto-generate user / API documentation + vimtags

Author: github-actions[bot]

doc/plugin-template.txt

@@ -1,4 +1,4 @@
-*plugin-template.txt*      For Neovim >= 0.8.0      Last change: 2025 April 06
+*plugin-template.txt*      For Neovim >= 0.8.0      Last change: 2025 April 12
 
 ==============================================================================
 Table of Contents                          *plugin-template-table-of-contents*
@@ -14,8 +14,13 @@ Table of Contents                          *plugin-template-table-of-contents*
 7. Tests                                               |plugin-template-tests|
   - Initialization                      |plugin-template-tests-initialization|
   - Running                                    |plugin-template-tests-running|
-8. Tracking Updates                         |plugin-template-tracking-updates|
-9. Other Plugins                               |plugin-template-other-plugins|
+8. Coverage                                         |plugin-template-coverage|
+  - Setup                                     |plugin-template-coverage-setup|
+  - Running                                 |plugin-template-coverage-running|
+  - Viewing                                 |plugin-template-coverage-viewing|
+9. Tracking Updates                         |plugin-template-tracking-updates|
+10. Other Plugins                              |plugin-template-other-plugins|
+11. Links                                              |plugin-template-links|
 
 ==============================================================================
 1. A Neovim Plugin Template         *plugin-template-a-neovim-plugin-template*
@@ -52,6 +57,7 @@ A template repository used to create Neovim plugins.
 - RSS feed support <https://github.com/ColinKennedy/nvim-best-practices-plugin-template/commits/main/doc/news.txt.atom>
 - Built-in logging to stdout / files
 - Unittests use the full power of native busted <https://github.com/lunarmodules/busted>
+    - Supports LuaCov <https://luarocks.org/modules/mpeterv/luacov> for coverage reports!
 - Automated testing matrix supports 12 Neovim/OS combinations
     - neovim: `[v0.10.0, v0.11.0, stable, nightly]`
     - os: `[ubuntu-latest, macos-latest, windows-latest]`
@@ -274,7 +280,52 @@ Run test based on tags
 
 
 ==============================================================================
-8. Tracking Updates                         *plugin-template-tracking-updates*
+8. Coverage                                         *plugin-template-coverage*
+
+Making sure that your plugin is well tested is important.
+`nvim-best-practices-plugin-template` can generate a per-line breakdown of
+exactly where your code is lacking tests using LuaCov
+<https://luarocks.org/modules/mpeterv/luacov>.
+
+
+SETUP                                         *plugin-template-coverage-setup*
+
+Make sure to install all dependencies for the unittests + coverage reporter if
+you have not installed them already.
+
+>sh
+    luarocks install busted --local
+    luarocks install luacov --local
+    luarocks install luacov-multiple --local
+<
+
+
+RUNNING                                     *plugin-template-coverage-running*
+
+>sh
+    make coverage-html
+<
+
+This will generate a `luacov.stats.out` & `luacov_html/` directory.
+
+
+VIEWING                                     *plugin-template-coverage-viewing*
+
+>sh
+    (cd luacov_html && python -m http.server)
+<
+
+If it worked, you should see a message like "Serving HTTP on 0.0.0.0 port 8000
+<http://0.0.0.0:8000> …" Open `http://0.0.0.0:8000/` in a browser like
+Firefox <https://www.mozilla.org/en-US/firefox> and you should see a view like
+this:
+
+Just navigate down a few folders until you get to a .lua file and you’ll see
+a breakdown of your line coverage like this:
+
+
+==============================================================================
+9. Tracking Updates                         *plugin-template-tracking-updates*
 
 See doc/news.txt <doc/news.txt> for updates.
 
@@ -286,13 +337,19 @@ You can watch this plugin for changes by adding this URL to your RSS feed:
 
 
 ==============================================================================
-9. Other Plugins                               *plugin-template-other-plugins*
+10. Other Plugins                              *plugin-template-other-plugins*
 
 This template is full of various features. But if your plugin is only meant to
 be a simple plugin and you don’t want the bells and whistles that this
 template provides, consider instead using nvim-plugin-template
 <https://github.com/ellisonleao/nvim-plugin-template>
 
+==============================================================================
+11. Links                                              *plugin-template-links*
+
+1. *Image*: https://github.com/user-attachments/assets/e5b30df8-036a-4886-81b9-affbf5c9e32a
+2. *Image*: https://github.com/user-attachments/assets/c5420b16-4be7-4177-92c7-01af0b418816
+
 Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
 
 vim:tw=78:ts=8:noet:ft=help:norl:

doc/tags

@@ -3,8 +3,13 @@ plugin-template-commands	plugin-template.txt	/*plugin-template-commands*
 plugin-template-configuration	plugin-template.txt	/*plugin-template-configuration*
 plugin-template-configuration-lualine	plugin-template.txt	/*plugin-template-configuration-lualine*
 plugin-template-configuration-telescope	plugin-template.txt	/*plugin-template-configuration-telescope*
+plugin-template-coverage	plugin-template.txt	/*plugin-template-coverage*
+plugin-template-coverage-running	plugin-template.txt	/*plugin-template-coverage-running*
+plugin-template-coverage-setup	plugin-template.txt	/*plugin-template-coverage-setup*
+plugin-template-coverage-viewing	plugin-template.txt	/*plugin-template-coverage-viewing*
 plugin-template-features	plugin-template.txt	/*plugin-template-features*
 plugin-template-installation	plugin-template.txt	/*plugin-template-installation*
+plugin-template-links	plugin-template.txt	/*plugin-template-links*
 plugin-template-new-breaking	news.txt	/*plugin-template-new-breaking*
 plugin-template-new-features	news.txt	/*plugin-template-new-features*
 plugin-template-news.txt	news.txt	/*plugin-template-news.txt*