nvim-tree
diff --git a/‎.github/workflows/ci.yml‎
Lines changed: 10 additions & 2 deletions b/‎.github/workflows/ci.yml‎
Lines changed: 10 additions & 2 deletions
diff --git a/‎CONTRIBUTING.md‎
Lines changed: 21 additions & 9 deletions b/‎CONTRIBUTING.md‎
Lines changed: 21 additions & 9 deletions
diff --git a/‎Makefile‎
Lines changed: 9 additions & 5 deletions b/‎Makefile‎
Lines changed: 9 additions & 5 deletions
@@ -53,6 +53,7 @@ jobs:
 
     env:
       VIMRUNTIME: /home/runner/nvim-${{ matrix.nvim_version }}/share/nvim/runtime
+      DIR_NVIM_SRC: /home/runner/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 "${DIR_NVIM_SRC}"
+          curl -L "https://github.com/neovim/neovim/archive/refs/tags/${{ matrix.nvim_version }}.tar.gz" | tar zx --directory "${DIR_NVIM_SRC}/.."
+          cd "${DIR_NVIM_SRC}"
+          make
+
+      - run: make help-check
@@ -18,9 +18,8 @@ markdown-toc --maxdepth=2 -i CONTRIBUTING.md
   * [check](#check)
 - [Diagnostics](#diagnostics)
 - [Backwards Compatibility](#backwards-compatibility)
-- [Adding New Actions](#adding-new-actions)
 - [Documentation](#documentation)
-  * [Opts](#opts)
+  * [Config And Mappings](#config-and-mappings)
   * [API](#api)
 - [Windows](#windows)
 - [Pull Request](#pull-request)
@@ -120,19 +119,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 config
+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
 
 
@@ -12,18 +12,19 @@ check: luals
 #
 # subtasks
 #
+# TODO #3241 ensure that decorator is checked - all meta should be valid
 luacheck:
-	luacheck --codes --quiet lua --exclude-files "**/_meta/**"
+	luacheck --codes --quiet lua --exclude-files "**/_meta/api_decorator.lua"
+	luacheck --codes --quiet scripts
 
-# --diagnosis-as-error does not function for workspace, hence we post-process the output
 style-check:
-	@scripts/luals-check.sh codestyle-check
+	scripts/luals-check.sh codestyle-check
 
 style-doc:
 	scripts/doc-comments.sh
 
 luals:
-	@scripts/luals-check.sh
+	scripts/luals-check.sh
 
 #
 # fixes
@@ -35,13 +36,16 @@ style-fix:
 # utility
 #
 help-update:
+	scripts/gen_vimdoc.sh
 	scripts/help-update.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
+	scripts/lintdoc.sh
+	git diff --ignore-blank-lines --exit-code doc/nvim-tree-lua.txt
 
 
 .PHONY: all lint style check luacheck style-check style-doc luals style-fix help-update help-check
Original file line number	Diff line number	Diff line change
`@@ -12,18 +12,19 @@ check: luals`
`12`	`12`	`#`
`13`	`13`	`# subtasks`
`14`	`14`	`#`
	`15`	`+# TODO #3241 ensure that decorator is checked - all meta should be valid`
`15`	`16`	`luacheck:`
`16`		`- luacheck --codes --quiet lua --exclude-files "/_meta/"`
	`17`	`+ luacheck --codes --quiet lua --exclude-files "**/_meta/api_decorator.lua"`
	`18`	`+ luacheck --codes --quiet scripts`
`17`	`19`
`18`		`-# --diagnosis-as-error does not function for workspace, hence we post-process the output`
`19`	`20`	`style-check:`
`20`		`- @scripts/luals-check.sh codestyle-check`
	`21`	`+ scripts/luals-check.sh codestyle-check`
`21`	`22`
`22`	`23`	`style-doc:`
`23`	`24`	`scripts/doc-comments.sh`
`24`	`25`
`25`	`26`	`luals:`
`26`		`- @scripts/luals-check.sh`
	`27`	`+ scripts/luals-check.sh`
`27`	`28`
`28`	`29`	`#`
`29`	`30`	`# fixes`
`@@ -35,13 +36,16 @@ style-fix:`
`35`	`36`	`# utility`
`36`	`37`	`#`
`37`	`38`	`help-update:`
	`39`	`+ scripts/gen_vimdoc.sh`
`38`	`40`	`scripts/help-update.sh`
`39`	`41`
`40`	`42`	`#`
`41`	`43`	`# CI`
	`44`	`+# --ignore-blank-lines is used as nightly has removed unnecessary blank lines that stable (0.11.5) currently inserts`
`42`	`45`	`#`
`43`	`46`	`help-check: help-update`
`44`		`- git diff --exit-code doc/nvim-tree-lua.txt`
	`47`	`+ scripts/lintdoc.sh`
	`48`	`+ git diff --ignore-blank-lines --exit-code doc/nvim-tree-lua.txt`
`45`	`49`
`46`	`50`
`47`	`51`	`.PHONY: all lint style check luacheck style-check style-doc luals style-fix help-update help-check`