Skip to content

Parse *= separately in types #39457

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.

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

Merged
merged 3 commits into from
Jul 7, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 8 additions & 15 deletions src/compiler/parser.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2701,19 +2701,10 @@ namespace ts {
return finishNode(factory.createThisTypeNode(), pos);
}

function parseJSDocAllType(postFixEquals: boolean): JSDocAllType | JSDocOptionalType {
function parseJSDocAllType(): JSDocAllType | JSDocOptionalType {
const pos = getNodePos();
nextToken();

const node = factory.createJSDocAllType();
if (postFixEquals) {
// Trim the trailing `=` from the `*=` token
const end = Math.max(getNodePos() - 1, pos);
return finishNode(factory.createJSDocOptionalType(finishNode(node, pos, end)), pos);
}
else {
return finishNode(node, pos);
}
return finishNode(factory.createJSDocAllType(), pos);
}

function parseJSDocNonNullableType(): TypeNode {
Expand Down Expand Up @@ -3396,12 +3387,14 @@ namespace ts {
case SyntaxKind.ObjectKeyword:
// If these are followed by a dot, then parse these out as a dotted type reference instead.
return tryParse(parseKeywordAndNoDot) || parseTypeReference();
case SyntaxKind.AsteriskToken:
return parseJSDocAllType(/*postfixEquals*/ false);
case SyntaxKind.AsteriskEqualsToken:
return parseJSDocAllType(/*postfixEquals*/ true);
// If there is '*=', treat it as * followed by postfix =
scanner.reScanAsteriskEqualsToken();
// falls through
case SyntaxKind.AsteriskToken:
return parseJSDocAllType();
case SyntaxKind.QuestionQuestionToken:
// If there is '??', consider that is prefix '?' in JSDoc type.
// If there is '??', treat it as prefix-'?' in JSDoc type.
scanner.reScanQuestionToken();
// falls through
case SyntaxKind.QuestionToken:
Expand Down
8 changes: 8 additions & 0 deletions src/compiler/scanner.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ namespace ts {
getTokenFlags(): TokenFlags;
reScanGreaterToken(): SyntaxKind;
reScanSlashToken(): SyntaxKind;
reScanAsteriskEqualsToken(): SyntaxKind;
reScanTemplateToken(isTaggedTemplate: boolean): SyntaxKind;
reScanTemplateHeadOrNoSubstitutionTemplate(): SyntaxKind;
scanJsxIdentifier(): SyntaxKind;
Expand Down Expand Up @@ -954,6 +955,7 @@ namespace ts {
getNumericLiteralFlags: () => tokenFlags & TokenFlags.NumericLiteralFlags,
getTokenFlags: () => tokenFlags,
reScanGreaterToken,
reScanAsteriskEqualsToken,
reScanSlashToken,
reScanTemplateToken,
reScanTemplateHeadOrNoSubstitutionTemplate,
Expand Down Expand Up @@ -2086,6 +2088,12 @@ namespace ts {
return token;
}

function reScanAsteriskEqualsToken(): SyntaxKind {
Debug.assert(token === SyntaxKind.AsteriskEqualsToken, "'reScanAsteriskEqualsToken' should only be called on a '*='");
pos = tokenPos + 1;
return token = SyntaxKind.EqualsToken;
}

function reScanSlashToken(): SyntaxKind {
if (token === SyntaxKind.SlashToken || token === SyntaxKind.SlashEqualsToken) {
let p = tokenPos + 1;
Expand Down
1 change: 1 addition & 0 deletions tests/baselines/reference/api/tsserverlibrary.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3902,6 +3902,7 @@ declare namespace ts {
isUnterminated(): boolean;
reScanGreaterToken(): SyntaxKind;
reScanSlashToken(): SyntaxKind;
reScanAsteriskEqualsToken(): SyntaxKind;
reScanTemplateToken(isTaggedTemplate: boolean): SyntaxKind;
reScanTemplateHeadOrNoSubstitutionTemplate(): SyntaxKind;
scanJsxIdentifier(): SyntaxKind;
Expand Down
1 change: 1 addition & 0 deletions tests/baselines/reference/api/typescript.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3902,6 +3902,7 @@ declare namespace ts {
isUnterminated(): boolean;
reScanGreaterToken(): SyntaxKind;
reScanSlashToken(): SyntaxKind;
reScanAsteriskEqualsToken(): SyntaxKind;
reScanTemplateToken(isTaggedTemplate: boolean): SyntaxKind;
reScanTemplateHeadOrNoSubstitutionTemplate(): SyntaxKind;
scanJsxIdentifier(): SyntaxKind;
Expand Down
7 changes: 7 additions & 0 deletions tests/baselines/reference/jsdocParseStarEquals.symbols
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,10 @@ function f(...args) {
var x;
>x : Symbol(x, Decl(a.js, 7, 3))


/** @param {function():*=} f */
function cbf(f) {
>cbf : Symbol(cbf, Decl(a.js, 7, 6))
>f : Symbol(f, Decl(a.js, 11, 13))
}

11 changes: 9 additions & 2 deletions tests/baselines/reference/jsdocParseStarEquals.types
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
/** @param {...*=} args
@return {*=} */
function f(...args) {
>f : (...args: (any | undefined)[]) => any | undefined
>args : any[]
>f : (...args?: any[] | undefined) => any | undefined
>args : any

return null
>null : null
Expand All @@ -13,3 +13,10 @@ function f(...args) {
var x;
>x : any


/** @param {function():*=} f */
function cbf(f) {
>cbf : (f?: (() => any) | undefined) => void
>f : (() => any) | undefined
}

5 changes: 5 additions & 0 deletions tests/cases/conformance/jsdoc/jsdocParseStarEquals.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,8 @@ function f(...args) {

/** @type *= */
var x;


/** @param {function():*=} f */
function cbf(f) {
}