lintdoc.lua 573 B

123456789101112131415161718192021
  1. #!/usr/bin/env -S nvim -l
  2. -- Validate vimdoc files on $VIMRUNTIME/doc, and test generating HTML docs.
  3. -- Checks for duplicate/missing tags, parse errors, and invalid links/urls/spellings.
  4. -- See also `make lintdoc`.
  5. --
  6. -- Usage:
  7. -- $ nvim -l scripts/lintdoc.lua
  8. -- $ make lintdoc
  9. print('Running lintdoc ...')
  10. -- gen_help_html requires :helptags to be generated on $VIMRUNTIME/doc
  11. -- :helptags checks for duplicate tags.
  12. vim.cmd [[ helptags ALL ]]
  13. require('scripts.gen_help_html').run_validate()
  14. require('scripts.gen_help_html').test_gen()
  15. print('lintdoc PASSED.')