Fix indentation preservation in JSDoc (#37717) #37891
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
This fixes two bugs in the parseJSDocCommentWorker(). 1. The initial indent was calculated wrongly. It was set to the difference between the index of the last newline or beginning of file and the current start marker (position of /**). By calculating it this way, the newline character itself is counted as indentation character as well. The initial indent is used as margin for the whole comment. The margin contains the amount of characters to skip before the actual content or payload of a comment line. The algorithm does not skip non-whitespace characters at the beginning of the content, but it would strip away one whitespace character for indented content (which does matter, if there is e.g. a Markdown code block with indentation in the comment). 2. When reducing initial whitespace sequences of comment lines by the remaining margin the algorithm cut off one character too much. This might have been introduced to fix 1. It had a similar effect as 1.
|
|
This was referenced Apr 13, 2020
andrewbranch
approved these changes
Aug 4, 2020
sandersn
approved these changes
Aug 4, 2020
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
4 participants
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.
This fixes two bugs in the parseJSDocCommentWorker().
The initial indent was calculated wrongly. It was set to the
difference between the index of the last newline or beginning of file
and the current start marker (position of /**). By calculating it
this way, the newline character itself is counted as indentation
character as well. The initial indent is used as margin for the
whole comment. The margin contains the amount of characters to skip
before the actual content or payload of a comment line. The algorithm
does not skip non-whitespace characters at the beginning of the
content, but it would strip away one whitespace character for
indented content (which does matter, if there is e.g. a Markdown
code block with indentation in the comment).
When reducing initial whitespace sequences of comment lines by the
remaining margin the algorithm cut off one character too much. This
might have been introduced to fix 1. It had a similar effect as 1.
Fixes #37717