neovim/scripts
Jongwook Choi 01e82eba20
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.
2024-01-28 14:22:39 -08:00
..
bump_deps.lua build: enable lintlua for scripts/ dir #26391 2023-12-04 12:38:31 -08:00
check_urls.vim vim-patch: move test_urls.vim out of runtime/ 2018-11-12 12:36:40 -05:00
cliff.toml chore: forward-port changes from v0.8.2 release 2022-12-29 17:36:28 +01:00
download-unicode-files.sh build(lintsh): double quote to prevent word splitting (#21571) 2022-12-28 22:50:24 +01:00
gen_eval_files.lua feat: improve return type annotations for vim.api.* 2024-01-26 15:07:25 +00:00
gen_filetype.lua build: enable lintlua for scripts/ dir #26391 2023-12-04 12:38:31 -08:00
gen_help_html.lua build(docs): separate lint job to validate vimdoc #27227 2024-01-28 14:22:39 -08:00
gen_lsp.lua fix(lsp): clean up duplicate and unused meta type annotations 2024-01-20 14:02:16 +01:00
gen_vimdoc.py docs: auto-generate docs for vim.lpeg and vim.re 2024-01-14 11:08:33 +00:00
genappimage.sh build: make genappimage.sh work with existing CMAKE_INSTALL_PREFIX 2024-01-22 12:38:27 +01:00
git-log-pretty-since.sh build(lint): add more shell scripts to lintsh 2022-11-01 18:37:21 +01:00
legacy2luatest.pl legacy2luatest: Use before_each instead of setup. 2016-02-01 09:09:08 +01:00
lintcommit.lua build: enable lintlua for scripts/ dir #26391 2023-12-04 12:38:31 -08:00
lintdoc.lua build(docs): separate lint job to validate vimdoc #27227 2024-01-28 14:22:39 -08:00
lua2dox.lua fix(diagnostic): typing 2024-01-16 09:33:10 +00:00
movedocs.pl Move documentation from function declarations to definitions 2014-06-02 11:04:04 -03:00
release.sh build(lint): add more shell scripts to lintsh 2022-11-01 18:37:21 +01:00
shadacat.py Merge #11319 'inccommand: fix issues with modifiers and prompting' 2019-11-05 17:34:21 -08:00
update_terminfo.sh refactor: replace manual header guards with #pragma once 2023-11-12 22:01:28 +01:00
vim-patch.sh docs: move vim-patch wiki page to runtime documentation 2023-12-13 18:31:05 +01:00
vimpatch.lua build: enable lintlua for scripts/ dir #26391 2023-12-04 12:38:31 -08:00
windows.ti fix(terminfo): disable smglr for vtpcon and conemu (#18855) 2022-06-05 14:39:56 +02:00