Fix jsdoc comment parsing initial state #36661
Merged
Conversation
This file contains hidden or 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
Jsdoc comment parsing can be invoked in two modes: 1. top-level parsing, for comments not inside a tag. 2. tag parsing, for comment that occur after the semantic parts of a tag. Top-level parsing skips an initial * because it assumes that it is starting at the very beginning of a JSDoc comment. Tag parsing does not. The two modes are distinguished by an optional second parameter named `margin`. When `margin` is provided, it provides an initial indent used for comment alignment. Previously, the check for `margin` was a truthy check `if (margin)`. This check incorrectly treats `margin=""` the same as `margin=undefined`. This PR changes the check to `if (margin !== undefined)`, which correctly treats `margin=""` the same as `margin=" "`.
1. Use SawAsterisk start state. 2. @template needs to skip asterisk in addition to whitespace while parsing type parameter names.
andrewbranch
approved these changes
Feb 6, 2020
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.
Jsdoc comment parsing can be invoked in two modes:
Top-level parsing skips an initial
*because it assumes that it is starting at the very beginning of a JSDoc comment. Tag parsing does not.The two modes are distinguished by an optional second parameter named
margin. Whenmarginis provided, it provides an initial indent used for comment alignment.Previously, the check for
marginwas a truthy checkif (margin).This check incorrectly treats
margin=""the same asmargin=undefined.This PR changes the check to
if (margin !== undefined), which correctly treatsmargin=""the same asmargin=" ". Since the start state would now beSaveCommentsmuch more often, it also changes the start state of comment parsing toSawAsterisk, so that initial whitespace is ignored.SavingCommentsretains all text, which is a breaking change (though perhaps a desirable one, but I'm not going to fix it here.)Fixes #21402