From 01e82eba209a96f932d3497e580ab0ca749efafa Mon Sep 17 00:00:00 2001
From: Jongwook Choi <wookayin@gmail.com>
Date: Sun, 28 Jan 2024 17:22:39 -0500
Subject: 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.
---
 test/functional/lua/help_spec.lua | 60 ---------------------------------------
 1 file changed, 60 deletions(-)
 delete mode 100644 test/functional/lua/help_spec.lua

(limited to 'test')

diff --git a/test/functional/lua/help_spec.lua b/test/functional/lua/help_spec.lua
deleted file mode 100644
index 12fd942474..0000000000
--- a/test/functional/lua/help_spec.lua
+++ /dev/null
@@ -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)
-- 
cgit