build(docs): separate lint job to validate vimdoc #27227

Summary: Separate the lint job (`make lintdoc`) to validate runtime/doc,
it is no longer as a part of functionaltest (help_spec).

Build (cmake) and CI:

- `make lintdoc`: validate vimdoc files and test-generate HTML docs.
  CI will run this as a part of the "docs" workflow.

- `scripts/lintdoc.lua` is added as an entry point (executable script)
  for validating vimdoc files.

scripts/gen_help_html.lua:

- Move the tests for validating docs and generating HTMLs from
  `help_spec.lua` to `gen_help_html`. Added:
  - `gen_help_html.run_validate()`.
  - `gen_help_html.test_gen()`.

- Do not hard-code `help_dir` to `build/runtime/doc`, but resolve from
  `$VIMRUNTIME`. Therefore, the `make lintdoc` job will check doc files
  on `./runtime/doc`, not on `./build/runtime/doc`.

- Add type annotations for gen_help_html.
This commit is contained in:
Jongwook Choi 2024-01-28 17:22:39 -05:00 committed by GitHub
parent 47cd532bf1
commit 01e82eba20
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 169 additions and 106 deletions

View File

@ -7,6 +7,8 @@ on:
- 'src/nvim/eval.lua' - 'src/nvim/eval.lua'
- 'runtime/lua/**.lua' - 'runtime/lua/**.lua'
- 'runtime/doc/**' - 'runtime/doc/**'
- 'scripts/gen_vimdoc.py'
- 'scripts/gen_help_html.lua'
jobs: jobs:
docs: docs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
@ -30,3 +32,6 @@ jobs:
echo "::error::The doc generation produces the following changes:" echo "::error::The doc generation produces the following changes:"
git diff --color --exit-code git diff --color --exit-code
fi fi
- name: Validate docs
run: make lintdoc

View File

@ -263,7 +263,7 @@ add_custom_target(lintcommit
add_dependencies(lintcommit nvim_bin) add_dependencies(lintcommit nvim_bin)
add_custom_target(lint) add_custom_target(lint)
add_dependencies(lint lintc lintlua lintsh lintcommit) add_dependencies(lint lintc lintlua lintsh lintcommit lintdoc)
# Format # Format
add_glob_target( add_glob_target(

View File

@ -265,6 +265,12 @@ Many `:help` docs are autogenerated from (C or Lua) docstrings. To generate the
make doc make doc
``` ```
To validate the documentation files, run:
```bash
make lintdoc
```
If you need to modify or debug the documentation flow, these are the main files: If you need to modify or debug the documentation flow, these are the main files:
- `./scripts/gen_vimdoc.py`: - `./scripts/gen_vimdoc.py`:
Main doc generator. Drives doxygen to generate xml files, and scrapes those Main doc generator. Drives doxygen to generate xml files, and scrapes those
@ -282,6 +288,8 @@ If you need to modify or debug the documentation flow, these are the main files:
src/nvim/options.lua => runtime/doc/options.txt src/nvim/options.lua => runtime/doc/options.txt
``` ```
- `./scripts/lintdoc.lua`: Validation and linting of documentation files.
### Lua docstrings ### Lua docstrings
Use [LuaLS] annotations in Lua docstrings to annotate parameter types, return Use [LuaLS] annotations in Lua docstrings to annotate parameter types, return

View File

@ -117,7 +117,7 @@ functionaltest-lua: | nvim
$(BUILD_TOOL) -C build functionaltest $(BUILD_TOOL) -C build functionaltest
FORMAT=formatc formatlua format FORMAT=formatc formatlua format
LINT=lintlua lintsh lintc clang-analyzer lintcommit lint LINT=lintlua lintsh lintc clang-analyzer lintcommit lintdoc lint
TEST=functionaltest unittest TEST=functionaltest unittest
generated-sources benchmark $(FORMAT) $(LINT) $(TEST) doc: | build/.ran-cmake generated-sources benchmark $(FORMAT) $(LINT) $(TEST) doc: | build/.ran-cmake
$(CMAKE) --build build --target $@ $(CMAKE) --build build --target $@

View File

@ -2,32 +2,38 @@
-- --
-- NOTE: :helptags checks for duplicate tags, whereas this script checks _links_ (to tags). -- NOTE: :helptags checks for duplicate tags, whereas this script checks _links_ (to tags).
-- --
-- USAGE (For CI/local testing purposes): Simply `make lintdoc` or `scripts/lintdoc.lua`, which
-- basically does the following:
-- 1. :helptags ALL
-- 2. nvim -V1 -es +"lua require('scripts.gen_help_html').run_validate()" +q
-- 3. nvim -V1 -es +"lua require('scripts.gen_help_html').test_gen()" +q
--
-- USAGE (GENERATE HTML): -- USAGE (GENERATE HTML):
-- 1. Run `make helptags` first; this script depends on vim.fn.taglist(). -- 1. `:helptags ALL` first; this script depends on vim.fn.taglist().
-- 2. nvim -V1 -es --clean +"lua require('scripts.gen_help_html').gen('./build/runtime/doc/', 'target/dir/')" -- 2. nvim -V1 -es --clean +"lua require('scripts.gen_help_html').gen('$VIMRUNTIME/doc', 'target/dir/')" +q
-- - Read the docstring at gen(). -- - Read the docstring at gen().
-- 3. cd target/dir/ && jekyll serve --host 0.0.0.0 -- 3. cd target/dir/ && jekyll serve --host 0.0.0.0
-- 4. Visit http://localhost:4000/…/help.txt.html -- 4. Visit http://localhost:4000/…/help.txt.html
-- --
-- USAGE (VALIDATE): -- USAGE (VALIDATE):
-- 1. nvim -V1 -es +"lua require('scripts.gen_help_html').validate()" -- 1. nvim -V1 -es +"lua require('scripts.gen_help_html').validate('$VIMRUNTIME/doc')" +q
-- - validate() is 10x faster than gen(), so it is used in CI. -- - validate() is 10x faster than gen(), so it is used in CI.
-- --
-- SELF-TEST MODE: -- SELF-TEST MODE:
-- 1. nvim -V1 -es +"lua require('scripts.gen_help_html')._test()" -- 1. nvim -V1 -es +"lua require('scripts.gen_help_html')._test()" +q
-- --
-- NOTES: -- NOTES:
-- * gen() and validate() are the primary entrypoints. validate() only exists because gen() is too -- * gen() and validate() are the primary (programmatic) entrypoints. validate() only exists
-- slow (~1 min) to run in per-commit CI. -- because gen() is too slow (~1 min) to run in per-commit CI.
-- * visit_node() is the core function used by gen() to traverse the document tree and produce HTML. -- * visit_node() is the core function used by gen() to traverse the document tree and produce HTML.
-- * visit_validate() is the core function used by validate(). -- * visit_validate() is the core function used by validate().
-- * Files in `new_layout` will be generated with a "flow" layout instead of preformatted/fixed-width layout. -- * Files in `new_layout` will be generated with a "flow" layout instead of preformatted/fixed-width layout.
local tagmap = nil local tagmap = nil
local helpfiles = nil local helpfiles = nil
local invalid_links = {} local invalid_links = {} ---@type table<string, any>
local invalid_urls = {} local invalid_urls = {} ---@type table<string, any>
local invalid_spelling = {} local invalid_spelling = {} ---@type table<string, table<string, string>>
local spell_dict = { local spell_dict = {
Neovim = 'Nvim', Neovim = 'Nvim',
NeoVim = 'Nvim', NeoVim = 'Nvim',
@ -150,7 +156,8 @@ end
--- ---
--- TODO: fix this in the parser instead... https://github.com/neovim/tree-sitter-vimdoc --- TODO: fix this in the parser instead... https://github.com/neovim/tree-sitter-vimdoc
--- ---
--- @returns (fixed_url, removed_chars) where `removed_chars` is in the order found in the input. --- @param url string
--- @return string, string (fixed_url, removed_chars) where `removed_chars` is in the order found in the input.
local function fix_url(url) local function fix_url(url)
local removed_chars = '' local removed_chars = ''
local fixed_url = url local fixed_url = url
@ -656,8 +663,10 @@ local function visit_node(root, level, lang_tree, headings, opt, stats)
end end
end end
local function get_helpfiles(include) --- @param dir string e.g. '$VIMRUNTIME/doc'
local dir = './build/runtime/doc' --- @param include string[]|nil
--- @return string[]
local function get_helpfiles(dir, include)
local rv = {} local rv = {}
for f, type in vim.fs.dir(dir) do for f, type in vim.fs.dir(dir) do
if if
@ -1113,26 +1122,35 @@ local function gen_css(fname)
tofile(fname, css) tofile(fname, css)
end end
function M._test() -- Testing
tagmap = get_helptags('./build/runtime/doc')
helpfiles = get_helpfiles()
local function ok(cond, expected, actual) local function ok(cond, expected, actual, message)
assert( assert(
(not expected and not actual) or (expected and actual), (not expected and not actual) or (expected and actual),
'if "expected" is given, "actual" is also required' 'if "expected" is given, "actual" is also required'
) )
if expected then if expected then
assert(cond, ('expected %s, got: %s'):format(vim.inspect(expected), vim.inspect(actual))) assert(
cond,
('%sexpected %s, got: %s'):format(
message and (message .. '\n') or '',
vim.inspect(expected),
vim.inspect(actual)
)
)
return cond return cond
else else
return assert(cond) return assert(cond)
end end
end end
local function eq(expected, actual) local function eq(expected, actual, message)
return ok(expected == actual, expected, actual) return ok(vim.deep_equal(expected, actual), expected, actual, message)
end end
function M._test()
tagmap = get_helptags('$VIMRUNTIME/doc')
helpfiles = get_helpfiles(vim.fn.expand('$VIMRUNTIME/doc'))
ok(vim.tbl_count(tagmap) > 3000, '>3000', vim.tbl_count(tagmap)) ok(vim.tbl_count(tagmap) > 3000, '>3000', vim.tbl_count(tagmap))
ok( ok(
vim.endswith(tagmap['vim.diagnostic.set()'], 'diagnostic.txt'), vim.endswith(tagmap['vim.diagnostic.set()'], 'diagnostic.txt'),
@ -1169,20 +1187,25 @@ function M._test()
eq('https://example.com', fixed_url) eq('https://example.com', fixed_url)
eq('', removed_chars) eq('', removed_chars)
print('all tests passed') print('all tests passed.\n')
end end
--- @class nvim.gen_help_html.gen_result
--- @field helpfiles string[] list of generated HTML files, from the source docs {include}
--- @field err_count integer number of parse errors in :help docs
--- @field invalid_links table<string, any>
--- Generates HTML from :help docs located in `help_dir` and writes the result in `to_dir`. --- Generates HTML from :help docs located in `help_dir` and writes the result in `to_dir`.
--- ---
--- Example: --- Example:
--- ---
--- gen('./build/runtime/doc', '/path/to/neovim.github.io/_site/doc/', {'api.txt', 'autocmd.txt', 'channel.txt'}, nil) --- gen('$VIMRUNTIME/doc', '/path/to/neovim.github.io/_site/doc/', {'api.txt', 'autocmd.txt', 'channel.txt'}, nil)
--- ---
--- @param help_dir string Source directory containing the :help files. Must run `make helptags` first. --- @param help_dir string Source directory containing the :help files. Must run `make helptags` first.
--- @param to_dir string Target directory where the .html files will be written. --- @param to_dir string Target directory where the .html files will be written.
--- @param include table|nil Process only these filenames. Example: {'api.txt', 'autocmd.txt', 'channel.txt'} --- @param include string[]|nil Process only these filenames. Example: {'api.txt', 'autocmd.txt', 'channel.txt'}
--- ---
--- @returns info dict --- @return nvim.gen_help_html.gen_result result
function M.gen(help_dir, to_dir, include, commit, parser_path) function M.gen(help_dir, to_dir, include, commit, parser_path)
vim.validate { vim.validate {
help_dir = { help_dir = {
@ -1207,7 +1230,7 @@ function M.gen(help_dir, to_dir, include, commit, parser_path)
local err_count = 0 local err_count = 0
ensure_runtimepath() ensure_runtimepath()
tagmap = get_helptags(vim.fn.expand(help_dir)) tagmap = get_helptags(vim.fn.expand(help_dir))
helpfiles = get_helpfiles(include) helpfiles = get_helpfiles(help_dir, include)
to_dir = vim.fn.expand(to_dir) to_dir = vim.fn.expand(to_dir)
parser_path = parser_path and vim.fn.expand(parser_path) or nil parser_path = parser_path and vim.fn.expand(parser_path) or nil
@ -1233,6 +1256,7 @@ function M.gen(help_dir, to_dir, include, commit, parser_path)
print(('total errors: %d'):format(err_count)) print(('total errors: %d'):format(err_count))
print(('invalid tags:\n%s'):format(vim.inspect(invalid_links))) print(('invalid tags:\n%s'):format(vim.inspect(invalid_links)))
--- @type nvim.gen_help_html.gen_result
return { return {
helpfiles = helpfiles, helpfiles = helpfiles,
err_count = err_count, err_count = err_count,
@ -1240,13 +1264,21 @@ function M.gen(help_dir, to_dir, include, commit, parser_path)
} }
end end
-- Validates all :help files found in `help_dir`: --- @class nvim.gen_help_html.validate_result
-- - checks that |tag| links point to valid helptags. --- @field helpfiles integer number of generated helpfiles
-- - recursively counts parse errors ("ERROR" nodes) --- @field err_count integer number of parse errors
-- --- @field parse_errors table<string, string[]>
-- This is 10x faster than gen(), for use in CI. --- @field invalid_links table<string, any> invalid tags in :help docs
-- --- @field invalid_urls table<string, any> invalid URLs in :help docs
-- @returns results dict --- @field invalid_spelling table<string, table<string, string>> invalid spelling in :help docs
--- Validates all :help files found in `help_dir`:
--- - checks that |tag| links point to valid helptags.
--- - recursively counts parse errors ("ERROR" nodes)
---
--- This is 10x faster than gen(), for use in CI.
---
--- @return nvim.gen_help_html.validate_result result
function M.validate(help_dir, include, parser_path) function M.validate(help_dir, include, parser_path)
vim.validate { vim.validate {
help_dir = { help_dir = {
@ -1265,15 +1297,15 @@ function M.validate(help_dir, include, parser_path)
'valid vimdoc.{so,dll} filepath', 'valid vimdoc.{so,dll} filepath',
}, },
} }
local err_count = 0 local err_count = 0 ---@type integer
local files_to_errors = {} local files_to_errors = {} ---@type table<string, string[]>
ensure_runtimepath() ensure_runtimepath()
tagmap = get_helptags(vim.fn.expand(help_dir)) tagmap = get_helptags(vim.fn.expand(help_dir))
helpfiles = get_helpfiles(include) helpfiles = get_helpfiles(help_dir, include)
parser_path = parser_path and vim.fn.expand(parser_path) or nil parser_path = parser_path and vim.fn.expand(parser_path) or nil
for _, f in ipairs(helpfiles) do for _, f in ipairs(helpfiles) do
local helpfile = vim.fs.basename(f) local helpfile = assert(vim.fs.basename(f))
local rv = validate_one(f, parser_path) local rv = validate_one(f, parser_path)
print(('validated (%-4s errors): %s'):format(#rv.parse_errors, helpfile)) print(('validated (%-4s errors): %s'):format(#rv.parse_errors, helpfile))
if #rv.parse_errors > 0 then if #rv.parse_errors > 0 then
@ -1285,14 +1317,65 @@ function M.validate(help_dir, include, parser_path)
err_count = err_count + #rv.parse_errors err_count = err_count + #rv.parse_errors
end end
---@type nvim.gen_help_html.validate_result
return { return {
helpfiles = #helpfiles, helpfiles = #helpfiles,
err_count = err_count, err_count = err_count,
parse_errors = files_to_errors,
invalid_links = invalid_links, invalid_links = invalid_links,
invalid_urls = invalid_urls, invalid_urls = invalid_urls,
invalid_spelling = invalid_spelling, invalid_spelling = invalid_spelling,
parse_errors = files_to_errors,
} }
end end
--- Validates vimdoc files on $VIMRUNTIME. and print human-readable error messages if fails.
---
--- If this fails, try these steps (in order):
--- 1. Fix/cleanup the :help docs.
--- 2. Fix the parser: https://github.com/neovim/tree-sitter-vimdoc
--- 3. File a parser bug, and adjust the tolerance of this test in the meantime.
---
--- @param help_dir? string e.g. '$VIMRUNTIME/doc' or './runtime/doc'
function M.run_validate(help_dir)
help_dir = vim.fn.expand(help_dir or '$VIMRUNTIME/doc')
print('doc path = ' .. vim.uv.fs_realpath(help_dir))
local rv = M.validate(help_dir)
-- Check that we actually found helpfiles.
ok(rv.helpfiles > 100, '>100 :help files', rv.helpfiles)
eq({}, rv.parse_errors, 'no parse errors')
eq(0, rv.err_count, 'no parse errors')
eq({}, rv.invalid_links, 'invalid tags in :help docs')
eq({}, rv.invalid_urls, 'invalid URLs in :help docs')
eq(
{},
rv.invalid_spelling,
'invalid spelling in :help docs (see spell_dict in scripts/gen_help_html.lua)'
)
end
--- Test-generates HTML from docs.
---
--- 1. Test that gen_help_html.lua actually works.
--- 2. Test that parse errors did not increase wildly. Because we explicitly test only a few
--- :help files, we can be precise about the tolerances here.
--- @param help_dir? string e.g. '$VIMRUNTIME/doc' or './runtime/doc'
function M.test_gen(help_dir)
local tmpdir = assert(vim.fs.dirname(vim.fn.tempname()))
help_dir = vim.fn.expand(help_dir or '$VIMRUNTIME/doc')
print('doc path = ' .. vim.uv.fs_realpath(help_dir))
local rv = M.gen(
help_dir,
tmpdir,
-- Because gen() is slow (~30s), this test is limited to a few files.
{ 'pi_health.txt', 'help.txt', 'index.txt', 'nvim.txt' }
)
eq(4, #rv.helpfiles)
eq(0, rv.err_count, 'parse errors in :help docs')
eq({}, rv.invalid_links, 'invalid tags in :help docs')
end
return M return M

20
scripts/lintdoc.lua Executable file
View File

@ -0,0 +1,20 @@
#!/usr/bin/env -S nvim -l
-- Validate vimdoc files on $VIMRUNTIME/doc, and test generating HTML docs.
-- Checks for duplicate/missing tags, parse errors, and invalid links/urls/spellings.
-- See also `make lintdoc`.
--
-- Usage:
-- $ nvim -l scripts/lintdoc.lua
-- $ make lintdoc
print('Running lintdoc ...')
-- gen_help_html requires :helptags to be generated on $VIMRUNTIME/doc
-- :helptags checks for duplicate tags.
vim.cmd [[ helptags ALL ]]
require('scripts.gen_help_html').run_validate()
require('scripts.gen_help_html').test_gen()
print('lintdoc PASSED.')

View File

@ -953,3 +953,10 @@ add_custom_target(doc-eval DEPENDS ${GEN_EVAL_TOUCH})
add_custom_target(doc-vim DEPENDS ${VIMDOC_FILES}) add_custom_target(doc-vim DEPENDS ${VIMDOC_FILES})
add_custom_target(doc) add_custom_target(doc)
add_dependencies(doc doc-vim doc-eval) add_dependencies(doc doc-vim doc-eval)
add_custom_target(lintdoc
COMMAND ${CMAKE_COMMAND} -E env "VIMRUNTIME=${NVIM_RUNTIME_DIR}"
$<TARGET_FILE:nvim_bin> --clean -l scripts/lintdoc.lua
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
USES_TERMINAL)
add_dependencies(lintdoc nvim)

View File

@ -1,60 +0,0 @@
-- Tests for gen_help_html.lua. Validates :help tags/links and HTML doc generation.
--
-- TODO: extract parts of gen_help_html.lua into Nvim stdlib?
local helpers = require('test.functional.helpers')(after_each)
local clear = helpers.clear
local exec_lua = helpers.exec_lua
local eq = helpers.eq
local ok = helpers.ok
if helpers.skip(helpers.is_ci('cirrus'), 'No need to run this on Cirrus') then
return
end
describe(':help docs', function()
before_each(clear)
it('validate', function()
-- If this test fails, try these steps (in order):
-- 1. Fix/cleanup the :help docs.
-- 2. Fix the parser: https://github.com/neovim/tree-sitter-vimdoc
-- 3. File a parser bug, and adjust the tolerance of this test in the meantime.
local rv = exec_lua([[return require('scripts.gen_help_html').validate('./build/runtime/doc')]])
-- Check that we actually found helpfiles.
ok(rv.helpfiles > 100, '>100 :help files', rv.helpfiles)
eq({}, rv.parse_errors, 'no parse errors')
eq(0, rv.err_count, 'no parse errors')
eq({}, rv.invalid_links, 'invalid tags in :help docs')
eq({}, rv.invalid_urls, 'invalid URLs in :help docs')
eq(
{},
rv.invalid_spelling,
'invalid spelling in :help docs (see spell_dict in scripts/gen_help_html.lua)'
)
end)
it('gen_help_html.lua generates HTML', function()
-- 1. Test that gen_help_html.lua actually works.
-- 2. Test that parse errors did not increase wildly. Because we explicitly test only a few
-- :help files, we can be precise about the tolerances here.
local tmpdir = exec_lua('return vim.fs.dirname(vim.fn.tempname())')
-- Because gen() is slow (~30s), this test is limited to a few files.
local rv = exec_lua(
[[
local to_dir = ...
return require('scripts.gen_help_html').gen(
'./build/runtime/doc',
to_dir,
{ 'pi_health.txt', 'help.txt', 'index.txt', 'nvim.txt', }
)
]],
tmpdir
)
eq(4, #rv.helpfiles)
eq(0, rv.err_count, 'parse errors in :help docs')
eq({}, rv.invalid_links, 'invalid tags in :help docs')
end)
end)