Skip to content

Commit b39bb2b

Browse files
committed
docs(#2934): add lintdoc.sh to CI
1 parent 350b590 commit b39bb2b

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

Makefile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,11 @@ help-update:
4040

4141
#
4242
# CI
43+
# --ignore-blank-lines is used as nightly has removed unnecessary blank lines that stable (0.11.5) currently inserts
4344
#
4445
help-check: help-update
4546
git diff --ignore-blank-lines --exit-code doc/nvim-tree-lua.txt
47+
@scripts/lintdoc.sh
4648

4749

4850
.PHONY: all lint style check luacheck style-check style-doc luals style-fix help-update help-check

scripts/lintdoc.sh

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,18 @@
1515
set -e
1616

1717
if [ ! -d "${NVIM_SRC}" ]; then
18-
echo "\$NVIM_SRC not set"
19-
exit 1
18+
cat << EOM
19+
20+
\$NVIM_SRC not set
21+
22+
Compiled Nvim source is required to run src/gen/gen_vimdoc.lua
23+
24+
Please:
25+
mkdir -p src
26+
curl -L 'https://github.com/neovim/neovim/archive/refs/tags/stable.tar.gz' | tar zx --directory src
27+
NVIM_SRC=src/neovim-stable ${0}
28+
EOM
29+
exit 1
2030
fi
2131

2232
# runtime/doc in the nvim source is practically hardcoded, copy our help in

0 commit comments

Comments
 (0)