feat(gen_help_html.lua): adapt to new parser #20352
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
justinmk
force-pushed
the
genhtml
branch
6 times, most recently
from
3fb2736
to
d9d1547
Compare
justinmk
commented
Sep 28, 2022
| - Separate blocks (paragraphs) of content by a blank line(s). | ||
| - Do not use indentation in random places—that prevents the page from using | ||
| "flow" layout. If you need a preformatted section, put it in | ||
| a |help-codeblock| starting with ">". |
There was a problem hiding this comment.
Some doc guidelines for optimal formatting.
justinmk
commented
Sep 28, 2022
|
|
||
|
|
||
| - `ext_cmdline` Externalize the cmdline. |ui-cmdline| | ||
| - `ext_hlstate` Detailed highlight state. |ui-hlstate| |
There was a problem hiding this comment.
Use lists to list things... otherwise we are stuck with "hardwrap" / preformatted format.
justinmk
commented
Sep 28, 2022
| exec_lua('return vim.inspect(...)', rv.invalid_tags)) | ||
| -- TODO: Fix all parse errors in :help files. | ||
| ok(rv.err_count < 1300, '<1300 parse errors', rv.err_count) | ||
| eq({}, rv.invalid_links, exec_lua([[return 'found invalid :help tag links:\n'..vim.inspect(...)]], rv.invalid_links)) |
There was a problem hiding this comment.
invalid links are now at zero, so we can be strict here
justinmk
commented
Sep 28, 2022
| ok(exec_lua('return vim.tbl_count(...)', rv.invalid_tags) < 538, '<538', | ||
| exec_lua('return vim.inspect(...)', rv.invalid_tags)) | ||
| -- TODO: Fix all parse errors in :help files. | ||
| ok(rv.err_count < 1300, '<1300 parse errors', rv.err_count) |
There was a problem hiding this comment.
parse errors reduced from 24k to ~1k
justinmk
commented
Sep 28, 2022
| NeoVim = 'Nvim', | ||
| neovim = 'Nvim', | ||
| lua = 'Lua', | ||
| } |
There was a problem hiding this comment.
experimenting with other lint stuff here (TODO: obviously scripts/gen_help_html.lua is not really the place for "linting", will eventually revisit this)
justinmk
force-pushed
the
genhtml
branch
2 times, most recently
from
83f7ed4
to
5ebb282
Compare
- adapt to parser changes from neovim/tree-sitter-vimdoc#16 - numerous other generator improvements
justinmk
commented
Sep 28, 2022
| XDG_STATE_HOME='$XDG_CONFIG_HOME', | ||
| XDG_DATA_DIRS='$XDG_CONFIG_DIRS', | ||
| clear({ | ||
| args_rm={'runtimepath'}, |
There was a problem hiding this comment.
Here and in startup_spec.lua, remove the set runtimepath^=./build/lib/nvim/ added in this PR (which is necessary to find parsers not installed on the system).
justinmk
added a commit
to neovim/doc
that referenced
this pull request
Sep 28, 2022
Problem: The HTML :help docs generated by the new `gen_help_html.lua` do not mention the source commit-id in the footer. Solution: Since neovim/neovim#20352 the script now accepts a commit-id, so pass it.
justinmk
added a commit
to neovim/doc
that referenced
this pull request
Sep 28, 2022
Problem: The HTML :help docs generated by the new `gen_help_html.lua` do not mention the source commit-id in the footer. Solution: Since neovim/neovim#20352 the script now accepts a commit-id, so pass it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ref #11967