fix: don't assume heading type is module
#140
Open
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
ovflowd
approved these changes
Nov 9, 2024
ovflowd
reviewed
Nov 9, 2024
| @@ -130,5 +130,5 @@ export const parseHeadingIntoMetadata = (heading, depth) => { | |||
| } | |||
| } | |||
|
|
|||
| return { text: heading, type: 'module', name: heading, depth }; | |||
| return { text: heading, name: heading, depth }; | |||
There was a problem hiding this comment.
I wonder if this leads to headings without any type :)
Would suggest running a diff of the json of main and this branch.
There was a problem hiding this comment.
It does, but IMO that's the correct behavior, as we can't be certain the type is module, it could be misc, therefore, the type is empty.
I could also not do this change, and have it overwrite the module with misc when needed (I.E. json-legacy).
AugustinMauroy
approved these changes
Nov 9, 2024
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.
Description
According to the legacy parser:
https://github.com/nodejs/node/blob/0a00217a5f67ef4a22384cfc80eb6dd9a917fdc1/tools/doc/json.mjs#L478-L489
As shown above, the heading should not have a default value. The generators should decide whether a
miscormoduleheading is appropiate based on the heading of the parent.Validation
See updated tests
Related Issues
#139
Check List