docs(#2934): add nvim-tree.Config* class meta, generate help documentation

.github/workflows/ci.yml

@@ -53,6 +53,7 @@ jobs:
 
     env:
       VIMRUNTIME: /home/runner/nvim-${{ matrix.nvim_version }}/share/nvim/runtime
+      NVIM_SRC: src/neovim-${{ matrix.nvim_version }}
 
     steps:
       - name: checkout
@@ -72,8 +73,15 @@ jobs:
 
       - run: make check
 
-      - run: make help-check
-
       - run: make style
 
       - run: make style-doc
+
+      - name: build Nvim from source
+        run: |
+          mkdir -p src
+          curl -L "https://github.com/neovim/neovim/archive/refs/tags/${{ matrix.nvim_version }}.tar.gz" | tar zx --directory src
+          cd "${NVIM_SRC}"
+          make
+
+      - run: make help-check

.gitignore

@@ -1,4 +1,5 @@
 /luals-out/
 /luals/
+/src/
 # backup vim files
 *~

CONTRIBUTING.md

@@ -105,6 +105,7 @@ Suppressions are permitted only in the following cases:
 - Backwards compatibility shims
 - neovim API metadata incorrect, awaiting upstream fix
 - classic class framework
+- `gen_vimdoc_config.lua` help generator as it requires neovim source
 
 # Backwards Compatibility
 
@@ -120,19 +121,32 @@ else
 end
 ```
 
-# Adding New Actions
+# Documentation
 
-To add a new action, add a file in `actions/name-of-the-action.lua`. You should export a `setup` function if some configuration is needed.
+## Config And Mappings
 
-Once you did, you should run `make help-update`
+When adding to or changing:
+1. `DEFAULT_OPTS`
+2. `Config` classes
+3. `on_attach` default mappings
 
-# Documentation
+You must generate help documentation. This requires neovim stable sources. You will be promted with instructions on fetching and referencing the source.
 
-## Opts
+```sh
+make help-update
+```
 
-When adding new options, you should declare the defaults in the main `nvim-tree.lua` file.
+This will:
+1. Update config defaults in `*nvim-tree-setup*`
+2. Regenerate from `*nvim-tree-config*` to the end of the file, see `gen_vimdoc.sh`
+3. Update default mappings in `*nvim-tree-mappings-default*` and `*nvim-tree-quickstart-help*`
+
+Commit your changes then run:
+```sh
+make help-check
+```
 
-Documentation for options should also be added to `nvim-tree-opts` in `doc/nvim-tree-lua.txt`
+This will re-run `help-update` and check that there are no diffs. It will also lint the documentation, see `lintdoc.sh`
 
 ## API
 

Makefile

@@ -36,12 +36,15 @@ style-fix:
 #
 help-update:
 	scripts/help-update.sh
+	scripts/gen_vimdoc.sh
 
 #
 # CI
+# --ignore-blank-lines is used as nightly has removed unnecessary blank lines that stable (0.11.5) currently inserts
 #
 help-check: help-update
-	git diff --exit-code doc/nvim-tree-lua.txt
+	git diff --ignore-blank-lines --exit-code doc/nvim-tree-lua.txt
+	@scripts/lintdoc.sh
 
 
 .PHONY: all lint style check luacheck style-check style-doc luals style-fix help-update help-check