Skip to content

Don't slice whitespace in jsdoc parser unless needed #53121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
sandersn wants to merge 4 commits into from
Closed

Don't slice whitespace in jsdoc parser unless needed #53121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
000f7a5
Don't slice whitespace in jsdoc parser unless needed
sandersn Mar 6, 2023
6d792e7
Merge branch 'main' into lazy-whitespace-slicing-jsdoc-parser
sandersn Mar 7, 2023
794b0f3
Only slice once, and tokenise leading ` * ` as whitespace
sandersn Mar 7, 2023
ae16f5e
use lint-preferred empty-for formatting
sandersn Mar 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 24 additions & 11 deletions src/compiler/parser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2161,6 +2161,9 @@ namespace Parser {
return nextTokenWithoutCheck();
}

function nextTokenJSDocInitialIndent(): JSDocSyntaxKind {
return currentToken = scanner.scanJSDocInitialIndent();
}
function nextTokenJSDoc(): JSDocSyntaxKind {
return currentToken = scanner.scanJsDocToken();
}
Expand Down Expand Up @@ -8636,14 +8639,14 @@ namespace Parser {
break;
case SyntaxKind.WhitespaceTrivia:
// only collect whitespace if we're already saving comments or have just crossed the comment indent margin
const whitespace = scanner.getTokenText();
const whitespaceLength = scanner.getTextPos() - scanner.getTokenPos();
if (state === JSDocState.SavingComments) {
comments.push(whitespace);
comments.push(scanner.getTokenText());
}
else if (margin !== undefined && indent + whitespace.length > margin) {
comments.push(whitespace.slice(margin - indent));
else if (margin !== undefined && indent + whitespaceLength > margin) {
comments.push(scanner.getText().slice(scanner.getTokenPos() + margin - indent, scanner.getTextPos()));
}
indent += whitespace.length;
indent += whitespaceLength;
break;
case SyntaxKind.EndOfFileToken:
break loop;
Expand Down Expand Up @@ -8671,7 +8674,12 @@ namespace Parser {
pushComment(scanner.getTokenText());
break;
}
nextTokenJSDoc();
if (state === JSDocState.BeginningOfLine) {
nextTokenJSDocInitialIndent();
}
else {
nextTokenJSDoc();
}
}
removeTrailingWhitespace(comments);
if (parts.length && comments.length) {
Expand Down Expand Up @@ -8888,12 +8896,12 @@ namespace Parser {
pushComment(scanner.getTokenText());
}
else {
const whitespace = scanner.getTokenText();
const whitespaceLength = scanner.getTextPos() - scanner.getTokenPos();
// 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));
if (margin !== undefined && indent + whitespaceLength > margin) {
comments.push(scanner.getText().slice(scanner.getTokenPos() + margin - indent, scanner.getTextPos()));
}
indent += whitespace.length;
indent += whitespaceLength;
}
break;
case SyntaxKind.OpenBraceToken:
Expand Down Expand Up @@ -8937,7 +8945,12 @@ namespace Parser {
break;
}
previousWhitespace = token() === SyntaxKind.WhitespaceTrivia;
tok = nextTokenJSDoc();
if (state === JSDocState.BeginningOfLine) {
tok = nextTokenJSDocInitialIndent();
}
else {
tok = nextTokenJSDoc();
}
}

removeLeadingNewlines(comments);
Expand Down
18 changes: 18 additions & 0 deletions src/compiler/scanner.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ export interface Scanner {
reScanQuestionToken(): SyntaxKind;
reScanInvalidIdentifier(): SyntaxKind;
scanJsxToken(): JsxTokenSyntaxKind;
/** @internal */
scanJSDocInitialIndent(): JSDocSyntaxKind;
scanJsDocToken(): JSDocSyntaxKind;
scan(): SyntaxKind;

Expand Down Expand Up @@ -1019,6 +1021,7 @@ export function createScanner(languageVersion: ScriptTarget,
reScanQuestionToken,
reScanInvalidIdentifier,
scanJsxToken,
scanJSDocInitialIndent,
scanJsDocToken,
scan,
getText,
Expand Down Expand Up @@ -2455,6 +2458,21 @@ export function createScanner(languageVersion: ScriptTarget,
return scanJsxAttributeValue();
}

function scanJSDocInitialIndent(): JSDocSyntaxKind {
startPos = tokenPos = pos;
tokenFlags = TokenFlags.None;
if (pos >= end) {
return token = SyntaxKind.EndOfFileToken;
}
for (let ch = codePointAt(text, pos); // TODO: Only allow 1 (one) asterisk!
pos < end && (isWhiteSpaceSingleLine(ch) || ch === CharacterCodes.asterisk);
ch = codePointAt(text, pos += charSize(ch)));
if (pos === tokenPos) {
return scanJsDocToken();
}
return token = SyntaxKind.WhitespaceTrivia;
}

function scanJsDocToken(): JSDocSyntaxKind {
startPos = tokenPos = pos;
tokenFlags = TokenFlags.None;
Expand Down