docs(#2934): add lintdoc.sh, fix some branding spelling

Author: alex-courtis

doc/nvim-tree-lua.txt

@@ -1,4 +1,4 @@
-*nvim-tree* A File Explorer For nvim
+*nvim-tree* A File Explorer For Nvim
 
 Author: Yazdani Kiyan
 
@@ -105,7 +105,7 @@ Git Integration
 
 Requirements
 
-    This file explorer requires nvim >= 0.9
+    This file explorer requires Nvim >= 0.9
 
 ==============================================================================
  2. QUICKSTART                                          *nvim-tree-quickstart*
@@ -364,7 +364,7 @@ See |nvim-tree-highlight| for details.
  4. SETUP                                                    *nvim-tree-setup*
 
 You must run setup() function once to initialise nvim-tree. It may be called
-again to apply a change in configuration without restarting nvim.
+again to apply a change in configuration without restarting Nvim.
 
 setup() function takes one optional argument: configuration table. If omitted
 nvim-tree will be initialised with default configuration.
@@ -1235,18 +1235,18 @@ Takes the `BufEnter` event as an argument. see |autocmd-events|
 
 Open a file or directory in your preferred application.
 
-|vim.ui.open()| was introduced in nvim 0.10 and is the default.
+|vim.ui.open()| was introduced in Nvim 0.10 and is the default.
 
-Once nvim-tree minimum nvim version is updated to 0.10, these options will
+Once nvim-tree minimum Nvim version is updated to 0.10, these options will
 no longer be necessary and will be removed.
 
 *nvim-tree.system_open.cmd*
 The open command itself.
   Type: `string`, Default: `""`
 
-nvim >= 0.10 defaults to |vim.ui.open()|
+Nvim >= 0.10 defaults to |vim.ui.open()|
 
-nvim <  0.10 defaults to:
+Nvim <  0.10 defaults to:
   UNIX:    `"xdg-open"`
   macOS:   `"open"`
   Windows: `"cmd"`
@@ -1495,7 +1495,7 @@ Configuration for |nvim-tree-api.tree.expand_all()| and
 
     *nvim-tree.actions.expand_all.max_folder_discovery*
     Limit the number of folders being explored when expanding every folders.
-    Avoids hanging nvim when running this action on very large folders.
+    Avoids hanging Nvim when running this action on very large folders.
       Type: `number`, Default: `300`
 
     *nvim-tree.actions.expand_all.exclude*
@@ -3058,13 +3058,13 @@ Contents of `my-decorator.lua`:
 Windows WSL and PowerShell
 - Trash is synchronized
 - Executable file detection is disabled as this is non-performant and can
-  freeze nvim
+  freeze Nvim
 - Some filesystem watcher error related to permissions will not be reported
 
 ==============================================================================
  13. NETRW                                                   *nvim-tree-netrw*
 
-|netrw| is a standard nvim plugin that is enabled by default. It provides,
+|netrw| is a standard Nvim plugin that is enabled by default. It provides,
 amongst other functionality, a file/directory browser.
 
 It interferes with nvim-tree and the intended user experience is nvim-tree
@@ -3941,14 +3941,14 @@ Class: Config.SystemOpen                        *nvim-tree-config-system-open*
 *nvim_tree.Config.SystemOpen*
     Open files or directories via the OS.
 
-    nvim:
+    Nvim:
     • `>=` 0.10 uses |vim.ui.open()| unless {cmd} is specified
     • `<` 0.10 calls external {cmd}:
       • UNIX: `xdg-open`
       • macOS: `open`
       • Windows: `cmd`
 
-    Once nvim-tree minimum nvim version is updated to 0.10, these options will
+    Once nvim-tree minimum Nvim version is updated to 0.10, these options will
     no longer be necessary and will be removed.
 
     Fields: ~
@@ -4185,7 +4185,7 @@ Class: Config.Actions                               *nvim-tree-config-actions*
     Fields: ~
       • {max_folder_discovery}?  (`integer`, default: `300`) Limit the number
                                  of folders being explored when expanding
-                                 every folder. Avoids hanging nvim when
+                                 every folder. Avoids hanging Nvim when
                                  running this action on very large folders.
       • {exclude}?               (`string[]`, default: `{}`) A list of
                                  directories that should not be expanded

lua/nvim-tree/_meta/config/actions.lua

@@ -42,7 +42,7 @@ error("Cannot require a meta file")
 ---Configure [nvim-tree-api.tree.expand_all()] and [nvim-tree-api.node.expand()]
 ---@class nvim_tree.Config.Actions.ExpandAll
 ---
----Limit the number of folders being explored when expanding every folder. Avoids hanging nvim when running this action on very large folders.
+---Limit the number of folders being explored when expanding every folder. Avoids hanging Nvim when running this action on very large folders.
 ---(default: `300`)
 ---@field max_folder_discovery? integer
 ---

lua/nvim-tree/_meta/config/system_open.lua

@@ -3,14 +3,14 @@ error("Cannot require a meta file")
 
 ---Open files or directories via the OS.
 ---
----nvim:
+---Nvim:
 ---- `>=` 0.10 uses [vim.ui.open()] unless {cmd} is specified
 ---- `<` 0.10 calls external {cmd}:
 ---   - UNIX: `xdg-open`
 ---   - macOS: `open`
 ---   - Windows: `cmd`
 ---
----Once nvim-tree minimum nvim version is updated to 0.10, these options will no longer be necessary and will be removed.
+---Once nvim-tree minimum Nvim version is updated to 0.10, these options will no longer be necessary and will be removed.
 ---
 ---@class nvim_tree.Config.SystemOpen
 ---

scripts/gen_vimdoc.sh

@@ -1,9 +1,17 @@
 #!/usr/bin/env sh
 
+# Wrapper around nvim help generator gen_vimdoc.lua, run as part of nvim's make doc target.
+#
+# Doesn't require nvim to have been built.
+#
+# Shims our moudules into gen_vimdoc_config.lua, replacing nvim's.
+#
+# There are some hardcoded expectations which we work around as commented.
+
 set -e
 
-if [ ! -d "${NEOVIM_SRC}" ]; then
-	echo "\$NEOVIM_SRC not set"
+if [ ! -d "${NVIM_SRC}" ]; then
+	echo "\$NVIM_SRC not set"
 	exit 1
 fi
 
@@ -12,11 +20,11 @@ mkdir -pv runtime/doc
 cp -v "doc/nvim-tree-lua.txt" runtime/doc
 
 # modify gen_vimdoc.lua to use our config
-cp -v "${NEOVIM_SRC}/src/gen/gen_vimdoc.lua" gen_vimdoc.lua
+cp -v "${NVIM_SRC}/src/gen/gen_vimdoc.lua" gen_vimdoc.lua
 sed -i -E 's/spairs\(config\)/spairs\(require("gen_vimdoc_config")\)/g' gen_vimdoc.lua
 
 # use luacacts etc. from neovim src as well as our specific config
-export LUA_PATH="${NEOVIM_SRC}/src/?.lua;scripts/?.lua"
+export LUA_PATH="${NVIM_SRC}/src/?.lua;scripts/?.lua"
 
 # generate
 ./gen_vimdoc.lua

scripts/lintdoc.sh

@@ -0,0 +1,32 @@
+#!/usr/bin/env sh
+
+# Wrapper around nvim help linter lintdoc.lua, run as part of nvim's make lintdoc target.
+#
+# Requires nvim to have been built.
+#
+# Desired:
+# - tags valid
+# - links valid
+# Also:
+# - brand spelling, notably Nvim and Lua
+#
+# There are some hardcoded expectations which we work around as commented.
+
+set -e
+
+if [ ! -d "${NVIM_SRC}" ]; then
+	echo "\$NVIM_SRC not set"
+	exit 1
+fi
+
+# runtime/doc in the nvim source is practically hardcoded, copy our help in
+cp -v "doc/nvim-tree-lua.txt" "${NVIM_SRC}/runtime/doc"
+
+# run from within nvim source
+cd "${NVIM_SRC}"
+
+# make nvim 
+make
+
+# execute the lint
+VIMRUNTIME=runtime scripts/lintdoc.lua