Use nextToken() after parsing a tag name so we can parse type keywords (#26915)

Andy · web-flow · commit f71d6005a259 · 2018-09-13T15:49:06.000-07:00
* Use nextToken() after parsing a tag name so we can parse type keywords

* Make callback to skipWhitespaceOrAsterisk non-optional
diff --git a/src/compiler/checker.ts b/src/compiler/checker.ts
@@ -29938,10 +29938,11 @@ namespace ts {
         }
 
         function checkGrammarConstructorTypeParameters(node: ConstructorDeclaration) {
-            const jsdocTypeParameters = isInJSFile(node) && getJSDocTypeParameterDeclarations(node);
-            if (node.typeParameters || jsdocTypeParameters && jsdocTypeParameters.length) {
-                const { pos, end } = node.typeParameters || jsdocTypeParameters && jsdocTypeParameters[0] || node;
-                return grammarErrorAtPos(node, pos, end - pos, Diagnostics.Type_parameters_cannot_appear_on_a_constructor_declaration);
+            const jsdocTypeParameters = isInJSFile(node) ? getJSDocTypeParameterDeclarations(node) : undefined;
+            const range = node.typeParameters || jsdocTypeParameters && firstOrUndefined(jsdocTypeParameters);
+            if (range) {
+                const pos = range.pos === range.end ? range.pos : skipTrivia(getSourceFileOfNode(node).text, range.pos);
+                return grammarErrorAtPos(node, pos, range.end - pos, Diagnostics.Type_parameters_cannot_appear_on_a_constructor_declaration);
             }
         }
 
diff --git a/src/compiler/parser.ts b/src/compiler/parser.ts
@@ -6517,7 +6517,7 @@ namespace ts {
                     }
                 }
 
-                function skipWhitespaceOrAsterisk(): void {
+                function skipWhitespaceOrAsterisk(next: () => void): void {
                     if (token() === SyntaxKind.WhitespaceTrivia || token() === SyntaxKind.NewLineTrivia) {
                         if (lookAhead(isNextNonwhitespaceTokenEndOfFile)) {
                             return; // Don't skip whitespace prior to EoF (or end of comment) - that shouldn't be included in any node's range
@@ -6532,7 +6532,7 @@ namespace ts {
                         else if (token() === SyntaxKind.AsteriskToken) {
                             precedingLineBreak = false;
                         }
-                        nextJSDocToken();
+                        next();
                     }
                 }
 
@@ -6542,8 +6542,9 @@ namespace ts {
                     atToken.end = scanner.getTextPos();
                     nextJSDocToken();
 
-                    const tagName = parseJSDocIdentifierName();
-                    skipWhitespaceOrAsterisk();
+                    // Use 'nextToken' instead of 'nextJsDocToken' so we can parse a type like 'number' in `@enum number`
+                    const tagName = parseJSDocIdentifierName(/*message*/ undefined, nextToken);
+                    skipWhitespaceOrAsterisk(nextToken);
 
                     let tag: JSDocTag | undefined;
                     switch (tagName.escapedText) {
@@ -6687,7 +6688,7 @@ namespace ts {
                 }
 
                 function tryParseTypeExpression(): JSDocTypeExpression | undefined {
-                    skipWhitespaceOrAsterisk();
+                    skipWhitespaceOrAsterisk(nextJSDocToken);
                     return token() === SyntaxKind.OpenBraceToken ? parseJSDocTypeExpression() : undefined;
                 }
 
@@ -6727,7 +6728,7 @@ namespace ts {
                 function parseParameterOrPropertyTag(atToken: AtToken, tagName: Identifier, target: PropertyLikeParse, indent: number): JSDocParameterTag | JSDocPropertyTag {
                     let typeExpression = tryParseTypeExpression();
                     let isNameFirst = !typeExpression;
-                    skipWhitespaceOrAsterisk();
+                    skipWhitespaceOrAsterisk(nextJSDocToken);
 
                     const { name, isBracketed } = parseBracketNameInPropertyAndParamTag();
                     skipWhitespace();
@@ -6861,7 +6862,7 @@ namespace ts {
 
                 function parseTypedefTag(atToken: AtToken, tagName: Identifier, indent: number): JSDocTypedefTag {
                     const typeExpression = tryParseTypeExpression();
-                    skipWhitespaceOrAsterisk();
+                    skipWhitespaceOrAsterisk(nextJSDocToken);
 
                     const typedefTag = <JSDocTypedefTag>createNode(SyntaxKind.JSDocTypedefTag, atToken.pos);
                     typedefTag.atToken = atToken;
@@ -7114,7 +7115,7 @@ namespace ts {
                     return entity;
                 }
 
-                function parseJSDocIdentifierName(message?: DiagnosticMessage): Identifier {
+                function parseJSDocIdentifierName(message?: DiagnosticMessage, next: () => void = nextJSDocToken): Identifier {
                     if (!tokenIsIdentifierOrKeyword(token())) {
                         return createMissingNode<Identifier>(SyntaxKind.Identifier, /*reportAtCurrentPosition*/ !message, message || Diagnostics.Identifier_expected);
                     }
@@ -7125,7 +7126,7 @@ namespace ts {
                     result.escapedText = escapeLeadingUnderscores(scanner.getTokenText());
                     finishNode(result, end);
 
-                    nextJSDocToken();
+                    next();
                     return result;
                 }
             }
diff --git a/tests/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.@link tags.json b/tests/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.@link tags.json
@@ -6,7 +6,7 @@
         "0": {
             "kind": "JSDocTag",
             "pos": 63,
-            "end": 68,
+            "end": 67,
             "atToken": {
                 "kind": "AtToken",
                 "pos": 63,
@@ -22,7 +22,7 @@
         },
         "length": 1,
         "pos": 63,
-        "end": 68
+        "end": 67
     },
     "comment": "{@link first link}\nInside {@link link text} thing"
 }
diff --git a/tests/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.templateTag.json b/tests/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.templateTag.json
@@ -21,7 +21,7 @@
             "typeParameters": {
                 "0": {
                     "kind": "TypeParameter",
-                    "pos": 18,
+                    "pos": 17,
                     "end": 19,
                     "name": {
                         "kind": "Identifier",
@@ -31,7 +31,7 @@
                     }
                 },
                 "length": 1,
-                "pos": 18,
+                "pos": 17,
                 "end": 19
             }
         },
diff --git a/tests/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.templateTag2.json b/tests/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.templateTag2.json
@@ -21,7 +21,7 @@
             "typeParameters": {
                 "0": {
                     "kind": "TypeParameter",
-                    "pos": 18,
+                    "pos": 17,
                     "end": 19,
                     "name": {
                         "kind": "Identifier",
@@ -42,7 +42,7 @@
                     }
                 },
                 "length": 2,
-                "pos": 18,
+                "pos": 17,
                 "end": 21
             }
         },
diff --git a/tests/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.templateTag3.json b/tests/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.templateTag3.json
@@ -21,7 +21,7 @@
             "typeParameters": {
                 "0": {
                     "kind": "TypeParameter",
-                    "pos": 18,
+                    "pos": 17,
                     "end": 19,
                     "name": {
                         "kind": "Identifier",
@@ -42,7 +42,7 @@
                     }
                 },
                 "length": 2,
-                "pos": 18,
+                "pos": 17,
                 "end": 22
             }
         },
diff --git a/tests/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.templateTag4.json b/tests/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.templateTag4.json
@@ -21,7 +21,7 @@
             "typeParameters": {
                 "0": {
                     "kind": "TypeParameter",
-                    "pos": 18,
+                    "pos": 17,
                     "end": 19,
                     "name": {
                         "kind": "Identifier",
@@ -42,7 +42,7 @@
                     }
                 },
                 "length": 2,
-                "pos": 18,
+                "pos": 17,
                 "end": 22
             }
         },
diff --git a/tests/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.templateTag5.json b/tests/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.templateTag5.json
@@ -21,7 +21,7 @@
             "typeParameters": {
                 "0": {
                     "kind": "TypeParameter",
-                    "pos": 18,
+                    "pos": 17,
                     "end": 19,
                     "name": {
                         "kind": "Identifier",
@@ -42,7 +42,7 @@
                     }
                 },
                 "length": 2,
-                "pos": 18,
+                "pos": 17,
                 "end": 23
             }
         },
diff --git a/tests/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.templateTag6.json b/tests/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.templateTag6.json
@@ -21,7 +21,7 @@
             "typeParameters": {
                 "0": {
                     "kind": "TypeParameter",
-                    "pos": 18,
+                    "pos": 17,
                     "end": 19,
                     "name": {
                         "kind": "Identifier",
@@ -42,7 +42,7 @@
                     }
                 },
                 "length": 2,
-                "pos": 18,
+                "pos": 17,
                 "end": 24
             },
             "comment": "Description of type parameters."
diff --git a/tests/baselines/reference/enumTag.errors.txt b/tests/baselines/reference/enumTag.errors.txt
@@ -15,7 +15,7 @@ tests/cases/conformance/jsdoc/a.js(37,16): error TS2339: Property 'UNKNOWN' does
         /** @type {number} */
         OK_I_GUESS: 2
     }
-    /** @enum {number} */
+    /** @enum number */
     const Second = {
         MISTAKE: "end",
         ~~~~~~~~~~~~~~
diff --git a/tests/baselines/reference/enumTag.symbols b/tests/baselines/reference/enumTag.symbols
@@ -19,7 +19,7 @@ const Target = {
     OK_I_GUESS: 2
 >OK_I_GUESS : Symbol(OK_I_GUESS, Decl(a.js, 5, 15))
 }
-/** @enum {number} */
+/** @enum number */
 const Second = {
 >Second : Symbol(Second, Decl(a.js, 10, 5))
 
diff --git a/tests/baselines/reference/enumTag.types b/tests/baselines/reference/enumTag.types
@@ -25,7 +25,7 @@ const Target = {
 >OK_I_GUESS : number
 >2 : 2
 }
-/** @enum {number} */
+/** @enum number */
 const Second = {
 >Second : { MISTAKE: string; OK: number; FINE: number; }
 >{    MISTAKE: "end",    OK: 1,    /** @type {number} */    FINE: 2,} : { MISTAKE: string; OK: number; FINE: number; }
diff --git a/tests/baselines/reference/paramTagWrapping.errors.txt b/tests/baselines/reference/paramTagWrapping.errors.txt
@@ -1,5 +1,5 @@
-tests/cases/conformance/jsdoc/bad.js(2,11): error TS1003: Identifier expected.
-tests/cases/conformance/jsdoc/bad.js(2,11): error TS8024: JSDoc '@param' tag has name '', but there is no parameter with that name.
+tests/cases/conformance/jsdoc/bad.js(2,10): error TS1003: Identifier expected.
+tests/cases/conformance/jsdoc/bad.js(2,10): error TS8024: JSDoc '@param' tag has name '', but there is no parameter with that name.
 tests/cases/conformance/jsdoc/bad.js(5,4): error TS1003: Identifier expected.
 tests/cases/conformance/jsdoc/bad.js(5,4): error TS8024: JSDoc '@param' tag has name '', but there is no parameter with that name.
 tests/cases/conformance/jsdoc/bad.js(6,19): error TS1003: Identifier expected.
@@ -27,9 +27,9 @@ tests/cases/conformance/jsdoc/bad.js(9,20): error TS7006: Parameter 'z' implicit
 ==== tests/cases/conformance/jsdoc/bad.js (9 errors) ====
     /**
      * @param *
-              
+             
 !!! error TS1003: Identifier expected.
-              
+             
 !!! error TS8024: JSDoc '@param' tag has name '', but there is no parameter with that name.
      * {number} x Arg x.
      * @param {number}
diff --git a/tests/cases/conformance/jsdoc/enumTag.ts b/tests/cases/conformance/jsdoc/enumTag.ts
@@ -11,7 +11,7 @@ const Target = {
     /** @type {number} */
     OK_I_GUESS: 2
 }
-/** @enum {number} */
+/** @enum number */
 const Second = {
     MISTAKE: "end",
     OK: 1,

Original file line number	Diff line number	Diff line change
`@@ -29938,10 +29938,11 @@ namespace ts {`
`29938`	`29938`	`}`
`29939`	`29939`
`29940`	`29940`	`function checkGrammarConstructorTypeParameters(node: ConstructorDeclaration) {`
`29941`		`- const jsdocTypeParameters = isInJSFile(node) && getJSDocTypeParameterDeclarations(node);`
`29942`		`- if (node.typeParameters \|\| jsdocTypeParameters && jsdocTypeParameters.length) {`
`29943`		`- const { pos, end } = node.typeParameters \|\| jsdocTypeParameters && jsdocTypeParameters[0] \|\| node;`
`29944`		`- return grammarErrorAtPos(node, pos, end - pos, Diagnostics.Type_parameters_cannot_appear_on_a_constructor_declaration);`
	`29941`	`+ const jsdocTypeParameters = isInJSFile(node) ? getJSDocTypeParameterDeclarations(node) : undefined;`
	`29942`	`+ const range = node.typeParameters \|\| jsdocTypeParameters && firstOrUndefined(jsdocTypeParameters);`
	`29943`	`+ if (range) {`
	`29944`	`+ const pos = range.pos === range.end ? range.pos : skipTrivia(getSourceFileOfNode(node).text, range.pos);`
	`29945`	`+ return grammarErrorAtPos(node, pos, range.end - pos, Diagnostics.Type_parameters_cannot_appear_on_a_constructor_declaration);`
`29945`	`29946`	`}`
`29946`	`29947`	`}`
`29947`	`29948`
Original file line number	Diff line number	Diff line change
`@@ -6517,7 +6517,7 @@ namespace ts {`
`6517`	`6517`	`}`
`6518`	`6518`	`}`
`6519`	`6519`
`6520`		`- function skipWhitespaceOrAsterisk(): void {`
	`6520`	`+ function skipWhitespaceOrAsterisk(next: () => void): void {`
`6521`	`6521`	`if (token() === SyntaxKind.WhitespaceTrivia \|\| token() === SyntaxKind.NewLineTrivia) {`
`6522`	`6522`	`if (lookAhead(isNextNonwhitespaceTokenEndOfFile)) {`
`6523`	`6523`	`return; // Don't skip whitespace prior to EoF (or end of comment) - that shouldn't be included in any node's range`
`@@ -6532,7 +6532,7 @@ namespace ts {`
`6532`	`6532`	`else if (token() === SyntaxKind.AsteriskToken) {`
`6533`	`6533`	`precedingLineBreak = false;`
`6534`	`6534`	`}`
`6535`		`- nextJSDocToken();`
	`6535`	`+ next();`
`6536`	`6536`	`}`
`6537`	`6537`	`}`
`6538`	`6538`
`@@ -6542,8 +6542,9 @@ namespace ts {`
`6542`	`6542`	`atToken.end = scanner.getTextPos();`
`6543`	`6543`	`nextJSDocToken();`
`6544`	`6544`
`6545`		`- const tagName = parseJSDocIdentifierName();`
`6546`		`- skipWhitespaceOrAsterisk();`
	`6545`	+ // Use 'nextToken' instead of 'nextJsDocToken' so we can parse a type like 'number' in `@enum number`
	`6546`	`+ const tagName = parseJSDocIdentifierName(/message/ undefined, nextToken);`
	`6547`	`+ skipWhitespaceOrAsterisk(nextToken);`
`6547`	`6548`
`6548`	`6549`	`let tag: JSDocTag \| undefined;`
`6549`	`6550`	`switch (tagName.escapedText) {`
`@@ -6687,7 +6688,7 @@ namespace ts {`
`6687`	`6688`	`}`
`6688`	`6689`
`6689`	`6690`	`function tryParseTypeExpression(): JSDocTypeExpression \| undefined {`
`6690`		`- skipWhitespaceOrAsterisk();`
	`6691`	`+ skipWhitespaceOrAsterisk(nextJSDocToken);`
`6691`	`6692`	`return token() === SyntaxKind.OpenBraceToken ? parseJSDocTypeExpression() : undefined;`
`6692`	`6693`	`}`
`6693`	`6694`
`@@ -6727,7 +6728,7 @@ namespace ts {`
`6727`	`6728`	`function parseParameterOrPropertyTag(atToken: AtToken, tagName: Identifier, target: PropertyLikeParse, indent: number): JSDocParameterTag \| JSDocPropertyTag {`
`6728`	`6729`	`let typeExpression = tryParseTypeExpression();`
`6729`	`6730`	`let isNameFirst = !typeExpression;`
`6730`		`- skipWhitespaceOrAsterisk();`
	`6731`	`+ skipWhitespaceOrAsterisk(nextJSDocToken);`
`6731`	`6732`
`6732`	`6733`	`const { name, isBracketed } = parseBracketNameInPropertyAndParamTag();`
`6733`	`6734`	`skipWhitespace();`
`@@ -6861,7 +6862,7 @@ namespace ts {`
`6861`	`6862`
`6862`	`6863`	`function parseTypedefTag(atToken: AtToken, tagName: Identifier, indent: number): JSDocTypedefTag {`
`6863`	`6864`	`const typeExpression = tryParseTypeExpression();`
`6864`		`- skipWhitespaceOrAsterisk();`
	`6865`	`+ skipWhitespaceOrAsterisk(nextJSDocToken);`
`6865`	`6866`
`6866`	`6867`	`const typedefTag = <JSDocTypedefTag>createNode(SyntaxKind.JSDocTypedefTag, atToken.pos);`
`6867`	`6868`	`typedefTag.atToken = atToken;`
`@@ -7114,7 +7115,7 @@ namespace ts {`
`7114`	`7115`	`return entity;`
`7115`	`7116`	`}`
`7116`	`7117`
`7117`		`- function parseJSDocIdentifierName(message?: DiagnosticMessage): Identifier {`
	`7118`	`+ function parseJSDocIdentifierName(message?: DiagnosticMessage, next: () => void = nextJSDocToken): Identifier {`
`7118`	`7119`	`if (!tokenIsIdentifierOrKeyword(token())) {`
`7119`	`7120`	`return createMissingNode<Identifier>(SyntaxKind.Identifier, /reportAtCurrentPosition/ !message, message \|\| Diagnostics.Identifier_expected);`
`7120`	`7121`	`}`
`@@ -7125,7 +7126,7 @@ namespace ts {`
`7125`	`7126`	`result.escapedText = escapeLeadingUnderscores(scanner.getTokenText());`
`7126`	`7127`	`finishNode(result, end);`
`7127`	`7128`
`7128`		`- nextJSDocToken();`
	`7129`	`+ next();`
`7129`	`7130`	`return result;`
`7130`	`7131`	`}`
`7131`	`7132`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ tests/cases/conformance/jsdoc/a.js(37,16): error TS2339: Property 'UNKNOWN' does`
`15`	`15`	`/** @type {number} */`
`16`	`16`	`OK_I_GUESS: 2`
`17`	`17`	`}`
`18`		`- /** @enum {number} */`
	`18`	`+ /** @enum number */`
`19`	`19`	`const Second = {`
`20`	`20`	`MISTAKE: "end",`
`21`	`21`	`~~~~~~~~~~~~~~`