docs(#2934): lint and check scripts, rewrite luals check script following upstream changes

Author: alex-courtis

Makefile

@@ -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

scripts/gen_vimdoc_config.lua

@@ -52,8 +52,7 @@ for _, m in ipairs(srcs) do
   srcs_by_name[name] = m
 end
 
----@diagnostic disable-next-line: undefined-doc-name
---- @type table<string,nvim.gen_vimdoc.Config>
+-- @type table<string,nvim.gen_vimdoc.Config>
 local config = {
   all = {
     filename = "nvim-tree-lua.txt",

scripts/luals-check.sh

@@ -1,55 +1,65 @@
 #!/usr/bin/env sh
 
-# Performs a lua-language-server check on all files.
-# luals-out/check.json will be produced on any issues, returning 1.
-# Outputs only check.json to stdout, all other messages to stderr, to allow jq etc.
+# Performs a lua-language-server check on all lua files.
 # $VIMRUNTIME specifies neovim runtime path, defaults to "/usr/share/nvim/runtime" if unset.
 #
 # Call with codestyle-check param to enable only codestyle-check
+#
+# lua-language-server is inconsisent about which parameters must be absolute paths therefore we pass every path as absolute
+
+if [ $# -eq 1 ] && [ "${1}" != "codestyle-check" ] || [ $# -gt 1 ] ; then
+	echo "usage: ${0} [codestyle-check]" 1>&2
+	exit 1
+fi
+
+DIR_NVT="${PWD}"
+
+if [ ! -f "${DIR_NVT}/scripts/luals-check.sh" ]; then
+	echo "Must be run from nvim-tree root" 1>&2
+	exit 1
+fi
 
 if [ -z "${VIMRUNTIME}" ]; then
 	export VIMRUNTIME="/usr/share/nvim/runtime"
+	echo "Defaulting to VIMRUNTIME=${VIMRUNTIME}"
+fi
+
+if [ ! -d "${VIMRUNTIME}" ]; then
+	echo "\$VIMRUNTIME=${VIMRUNTIME} not found" 1>&2
+	exit 1
 fi
 
-DIR_SRC="${PWD}/lua"
-DIR_OUT="${PWD}/luals-out"
-FILE_LUARC="${DIR_OUT}/luarc.json"
+DIR_OUT="${DIR_NVT}/luals-out"
+LUARC="${DIR_OUT}/luarc.json"
+RC=0
 
-# clear output
+# clear previous output
 rm -rf "${DIR_OUT}"
 mkdir "${DIR_OUT}"
 
+# create the luarc.json for the requested check
 case "${1}" in
 	"codestyle-check")
 		jq \
 			'.diagnostics.neededFileStatus[] = "None" | .diagnostics.neededFileStatus."codestyle-check" = "Any"' \
-			"${PWD}/.luarc.json" > "${FILE_LUARC}"
+			"${DIR_NVT}/.luarc.json" > "${LUARC}"
 
 		;;
 	*)
-		cp "${PWD}/.luarc.json" "${FILE_LUARC}"
+		cp "${DIR_NVT}/.luarc.json" "${LUARC}"
 		;;
 esac
 
-# execute inside lua directory to prevent luals itself from being checked
-OUT=$(lua-language-server --check="${DIR_SRC}" --configpath="${FILE_LUARC}" --checklevel=Information --logpath="${DIR_OUT}" --loglevel=error)
-RC=$?
-
-echo "${OUT}" >&2
+for SRC in lua scripts; do
+	DIR_SRC="${DIR_NVT}/${SRC}"
+	FILE_OUT="${DIR_OUT}/out.${SRC}.log"
+	echo "Checking ${SRC}/"
 
-if [ $RC -ne 0 ]; then
-	echo "failed with RC=$RC"
-	exit $RC
-fi
+	lua-language-server --check="${DIR_SRC}" --configpath="${LUARC}" --checklevel=Information --logpath="${DIR_OUT}" --loglevel=error 2>&1 | tee "${FILE_OUT}"
 
-# any output is a fail
-case "${OUT}" in
-	*Diagnosis\ completed,\ no\ problems\ found*)
-		exit 0
-		;;
-	*)
-		cat "${DIR_OUT}/check.json"
-		exit 1
-		;;
-esac
+	if ! grep --quiet "Diagnosis completed, no problems found" "${FILE_OUT}"; then
+		RC=1
+	fi
+done
 
+exit "${RC}"