Fix some bad jsdoc comment indent #30838
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
Solves the initial problem but breaks commentCommentParsing. I also found a couple more interesting cases.
I may try do a little more; `margin += tag.end - tag.pos` bothers me a bit.
sandersn
requested review from
PranavSenthilnathan,
sheetalkamat,
uniqueiniquity and
andrewbranch
|
I added a few reviewers who might have parsed things in the past. |
sandersn
commented
Apr 9, 2019
| @@ -6441,7 +6441,6 @@ namespace ts { | |||
| // for malformed examples like `/** @param {string} x @returns {number} the length */` | |||
| state = JSDocState.BeginningOfLine; | |||
| margin = undefined; | |||
| indent++; | |||
There was a problem hiding this comment.
this was just wrong, as far as I can tell, but only was used for tags followed by a newline:
@ex
stuffThere was a problem hiding this comment.
That is, all our previous tests cases looked like this:
@param x comment
comment
indentNever like this:
@example
comment
comment
indentso this erroneous increment was hidden by the fact that indent had already passed margin.
| } | ||
|
|
||
| function parseTag(indent: number) { | ||
| function parseTag(margin: number) { |
There was a problem hiding this comment.
margin is the thing that's fixed, whereas indent goes up for each line. So this name was wrong before.
| @@ -6646,7 +6659,7 @@ namespace ts { | |||
| const whitespace = scanner.getTokenText(); | |||
| // if the whitespace crosses the margin, take only the whitespace that passes the margin | |||
| if (margin !== undefined && indent + whitespace.length > margin) { | |||
| comments.push(whitespace.slice(margin - indent - 1)); | |||
There was a problem hiding this comment.
this math was also wrong before, for the same reason as the indent++
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.
Fixes #15749 plus a few other cases I discovered.
Yes, I know the baseline format is horrible. Sorry.