fix(47713): allow JSDoc tags on CaseClause nodes (#47741)

a-tarasyuk · web-flow · commit 1b1530ae5279 · 2022-02-15T13:27:54.000-08:00
diff --git a/src/compiler/parser.ts b/src/compiler/parser.ts
@@ -6005,11 +6005,12 @@ namespace ts {
 
         function parseCaseClause(): CaseClause {
             const pos = getNodePos();
+            const hasJSDoc = hasPrecedingJSDocComment();
             parseExpected(SyntaxKind.CaseKeyword);
             const expression = allowInAnd(parseExpression);
             parseExpected(SyntaxKind.ColonToken);
             const statements = parseList(ParsingContext.SwitchClauseStatements, parseStatement);
-            return finishNode(factory.createCaseClause(expression, statements), pos);
+            return withJSDoc(finishNode(factory.createCaseClause(expression, statements), pos), hasJSDoc);
         }
 
         function parseDefaultClause(): DefaultClause {
diff --git a/src/compiler/types.ts b/src/compiler/types.ts
@@ -930,6 +930,7 @@ namespace ts {
         | ExportDeclaration
         | NamedTupleMember
         | ExportSpecifier
+        | CaseClause
         | EndOfFileToken
         ;
 
@@ -2801,7 +2802,7 @@ namespace ts {
         readonly clauses: NodeArray<CaseOrDefaultClause>;
     }
 
-    export interface CaseClause extends Node {
+    export interface CaseClause extends Node, JSDocContainer {
         readonly kind: SyntaxKind.CaseClause;
         readonly parent: CaseBlock;
         readonly expression: Expression;
diff --git a/tests/baselines/reference/api/tsserverlibrary.d.ts b/tests/baselines/reference/api/tsserverlibrary.d.ts
@@ -572,7 +572,7 @@ declare namespace ts {
     }
     export interface JSDocContainer {
     }
-    export type HasJSDoc = ParameterDeclaration | CallSignatureDeclaration | ClassStaticBlockDeclaration | ConstructSignatureDeclaration | MethodSignature | PropertySignature | ArrowFunction | ParenthesizedExpression | SpreadAssignment | ShorthandPropertyAssignment | PropertyAssignment | FunctionExpression | EmptyStatement | DebuggerStatement | Block | VariableStatement | ExpressionStatement | IfStatement | DoStatement | WhileStatement | ForStatement | ForInStatement | ForOfStatement | BreakStatement | ContinueStatement | ReturnStatement | WithStatement | SwitchStatement | LabeledStatement | ThrowStatement | TryStatement | FunctionDeclaration | ConstructorDeclaration | MethodDeclaration | VariableDeclaration | PropertyDeclaration | AccessorDeclaration | ClassLikeDeclaration | InterfaceDeclaration | TypeAliasDeclaration | EnumMember | EnumDeclaration | ModuleDeclaration | ImportEqualsDeclaration | ImportDeclaration | NamespaceExportDeclaration | ExportAssignment | IndexSignatureDeclaration | FunctionTypeNode | ConstructorTypeNode | JSDocFunctionType | ExportDeclaration | NamedTupleMember | ExportSpecifier | EndOfFileToken;
+    export type HasJSDoc = ParameterDeclaration | CallSignatureDeclaration | ClassStaticBlockDeclaration | ConstructSignatureDeclaration | MethodSignature | PropertySignature | ArrowFunction | ParenthesizedExpression | SpreadAssignment | ShorthandPropertyAssignment | PropertyAssignment | FunctionExpression | EmptyStatement | DebuggerStatement | Block | VariableStatement | ExpressionStatement | IfStatement | DoStatement | WhileStatement | ForStatement | ForInStatement | ForOfStatement | BreakStatement | ContinueStatement | ReturnStatement | WithStatement | SwitchStatement | LabeledStatement | ThrowStatement | TryStatement | FunctionDeclaration | ConstructorDeclaration | MethodDeclaration | VariableDeclaration | PropertyDeclaration | AccessorDeclaration | ClassLikeDeclaration | InterfaceDeclaration | TypeAliasDeclaration | EnumMember | EnumDeclaration | ModuleDeclaration | ImportEqualsDeclaration | ImportDeclaration | NamespaceExportDeclaration | ExportAssignment | IndexSignatureDeclaration | FunctionTypeNode | ConstructorTypeNode | JSDocFunctionType | ExportDeclaration | NamedTupleMember | ExportSpecifier | CaseClause | EndOfFileToken;
     export type HasType = SignatureDeclaration | VariableDeclaration | ParameterDeclaration | PropertySignature | PropertyDeclaration | TypePredicateNode | ParenthesizedTypeNode | TypeOperatorNode | MappedTypeNode | AssertionExpression | TypeAliasDeclaration | JSDocTypeExpression | JSDocNonNullableType | JSDocNullableType | JSDocOptionalType | JSDocVariadicType;
     export type HasTypeArguments = CallExpression | NewExpression | TaggedTemplateExpression | JsxOpeningElement | JsxSelfClosingElement;
     export type HasInitializer = HasExpressionInitializer | ForStatement | ForInStatement | ForOfStatement | JsxAttribute;
@@ -1498,7 +1498,7 @@ declare namespace ts {
         readonly parent: SwitchStatement;
         readonly clauses: NodeArray<CaseOrDefaultClause>;
     }
-    export interface CaseClause extends Node {
+    export interface CaseClause extends Node, JSDocContainer {
         readonly kind: SyntaxKind.CaseClause;
         readonly parent: CaseBlock;
         readonly expression: Expression;
diff --git a/tests/baselines/reference/api/typescript.d.ts b/tests/baselines/reference/api/typescript.d.ts
@@ -572,7 +572,7 @@ declare namespace ts {
     }
     export interface JSDocContainer {
     }
-    export type HasJSDoc = ParameterDeclaration | CallSignatureDeclaration | ClassStaticBlockDeclaration | ConstructSignatureDeclaration | MethodSignature | PropertySignature | ArrowFunction | ParenthesizedExpression | SpreadAssignment | ShorthandPropertyAssignment | PropertyAssignment | FunctionExpression | EmptyStatement | DebuggerStatement | Block | VariableStatement | ExpressionStatement | IfStatement | DoStatement | WhileStatement | ForStatement | ForInStatement | ForOfStatement | BreakStatement | ContinueStatement | ReturnStatement | WithStatement | SwitchStatement | LabeledStatement | ThrowStatement | TryStatement | FunctionDeclaration | ConstructorDeclaration | MethodDeclaration | VariableDeclaration | PropertyDeclaration | AccessorDeclaration | ClassLikeDeclaration | InterfaceDeclaration | TypeAliasDeclaration | EnumMember | EnumDeclaration | ModuleDeclaration | ImportEqualsDeclaration | ImportDeclaration | NamespaceExportDeclaration | ExportAssignment | IndexSignatureDeclaration | FunctionTypeNode | ConstructorTypeNode | JSDocFunctionType | ExportDeclaration | NamedTupleMember | ExportSpecifier | EndOfFileToken;
+    export type HasJSDoc = ParameterDeclaration | CallSignatureDeclaration | ClassStaticBlockDeclaration | ConstructSignatureDeclaration | MethodSignature | PropertySignature | ArrowFunction | ParenthesizedExpression | SpreadAssignment | ShorthandPropertyAssignment | PropertyAssignment | FunctionExpression | EmptyStatement | DebuggerStatement | Block | VariableStatement | ExpressionStatement | IfStatement | DoStatement | WhileStatement | ForStatement | ForInStatement | ForOfStatement | BreakStatement | ContinueStatement | ReturnStatement | WithStatement | SwitchStatement | LabeledStatement | ThrowStatement | TryStatement | FunctionDeclaration | ConstructorDeclaration | MethodDeclaration | VariableDeclaration | PropertyDeclaration | AccessorDeclaration | ClassLikeDeclaration | InterfaceDeclaration | TypeAliasDeclaration | EnumMember | EnumDeclaration | ModuleDeclaration | ImportEqualsDeclaration | ImportDeclaration | NamespaceExportDeclaration | ExportAssignment | IndexSignatureDeclaration | FunctionTypeNode | ConstructorTypeNode | JSDocFunctionType | ExportDeclaration | NamedTupleMember | ExportSpecifier | CaseClause | EndOfFileToken;
     export type HasType = SignatureDeclaration | VariableDeclaration | ParameterDeclaration | PropertySignature | PropertyDeclaration | TypePredicateNode | ParenthesizedTypeNode | TypeOperatorNode | MappedTypeNode | AssertionExpression | TypeAliasDeclaration | JSDocTypeExpression | JSDocNonNullableType | JSDocNullableType | JSDocOptionalType | JSDocVariadicType;
     export type HasTypeArguments = CallExpression | NewExpression | TaggedTemplateExpression | JsxOpeningElement | JsxSelfClosingElement;
     export type HasInitializer = HasExpressionInitializer | ForStatement | ForInStatement | ForOfStatement | JsxAttribute;
@@ -1498,7 +1498,7 @@ declare namespace ts {
         readonly parent: SwitchStatement;
         readonly clauses: NodeArray<CaseOrDefaultClause>;
     }
-    export interface CaseClause extends Node {
+    export interface CaseClause extends Node, JSDocContainer {
         readonly kind: SyntaxKind.CaseClause;
         readonly parent: CaseBlock;
         readonly expression: Expression;
diff --git a/tests/baselines/reference/quickInfoLink4.baseline b/tests/baselines/reference/quickInfoLink4.baseline
@@ -0,0 +1,64 @@
+[
+  {
+    "marker": {
+      "fileName": "/tests/cases/fourslash/quickInfoLink4.ts",
+      "position": 47,
+      "name": ""
+    },
+    "quickInfo": {
+      "kind": "type",
+      "kindModifiers": "",
+      "textSpan": {
+        "start": 47,
+        "length": 1
+      },
+      "displayParts": [
+        {
+          "text": "type",
+          "kind": "keyword"
+        },
+        {
+          "text": " ",
+          "kind": "space"
+        },
+        {
+          "text": "A",
+          "kind": "aliasName"
+        },
+        {
+          "text": " ",
+          "kind": "space"
+        },
+        {
+          "text": "=",
+          "kind": "operator"
+        },
+        {
+          "text": " ",
+          "kind": "space"
+        },
+        {
+          "text": "1",
+          "kind": "stringLiteral"
+        },
+        {
+          "text": " ",
+          "kind": "space"
+        },
+        {
+          "text": "|",
+          "kind": "punctuation"
+        },
+        {
+          "text": " ",
+          "kind": "space"
+        },
+        {
+          "text": "2",
+          "kind": "stringLiteral"
+        }
+      ],
+      "documentation": []
+    }
+  }
+]
diff --git a/tests/cases/fourslash/quickInfoLink4.ts b/tests/cases/fourslash/quickInfoLink4.ts
@@ -0,0 +1,13 @@
+///<reference path="fourslash.ts" />
+
+////type A = 1 | 2;
+////
+////switch (0 as A) {
+////	/** {@link /**/A} */
+////	case 1:
+////	case 2:
+////    break;
+////}
+
+verify.noErrors()
+verify.baselineQuickInfo();

Original file line number	Diff line number	Diff line change
`@@ -930,6 +930,7 @@ namespace ts {`
`930`	`930`	`\| ExportDeclaration`
`931`	`931`	`\| NamedTupleMember`
`932`	`932`	`\| ExportSpecifier`
	`933`	`+ \| CaseClause`
`933`	`934`	`\| EndOfFileToken`
`934`	`935`	`;`
`935`	`936`
`@@ -2801,7 +2802,7 @@ namespace ts {`
`2801`	`2802`	`readonly clauses: NodeArray<CaseOrDefaultClause>;`
`2802`	`2803`	`}`
`2803`	`2804`
`2804`		`- export interface CaseClause extends Node {`
	`2805`	`+ export interface CaseClause extends Node, JSDocContainer {`
`2805`	`2806`	`readonly kind: SyntaxKind.CaseClause;`
`2806`	`2807`	`readonly parent: CaseBlock;`
`2807`	`2808`	`readonly expression: Expression;`
Original file line number	Diff line number	Diff line change
`@@ -572,7 +572,7 @@ declare namespace ts {`
`572`	`572`	`}`
`573`	`573`	`export interface JSDocContainer {`
`574`	`574`	`}`
`575`		- export type HasJSDoc = ParameterDeclaration \| CallSignatureDeclaration \| ClassStaticBlockDeclaration \| ConstructSignatureDeclaration \| MethodSignature \| PropertySignature \| ArrowFunction \| ParenthesizedExpression \| SpreadAssignment \| ShorthandPropertyAssignment \| PropertyAssignment \| FunctionExpression \| EmptyStatement \| DebuggerStatement \| Block \| VariableStatement \| ExpressionStatement \| IfStatement \| DoStatement \| WhileStatement \| ForStatement \| ForInStatement \| ForOfStatement \| BreakStatement \| ContinueStatement \| ReturnStatement \| WithStatement \| SwitchStatement \| LabeledStatement \| ThrowStatement \| TryStatement \| FunctionDeclaration \| ConstructorDeclaration \| MethodDeclaration \| VariableDeclaration \| PropertyDeclaration \| AccessorDeclaration \| ClassLikeDeclaration \| InterfaceDeclaration \| TypeAliasDeclaration \| EnumMember \| EnumDeclaration \| ModuleDeclaration \| ImportEqualsDeclaration \| ImportDeclaration \| NamespaceExportDeclaration \| ExportAssignment \| IndexSignatureDeclaration \| FunctionTypeNode \| ConstructorTypeNode \| JSDocFunctionType \| ExportDeclaration \| NamedTupleMember \| ExportSpecifier \| EndOfFileToken;
	`575`	+ export type HasJSDoc = ParameterDeclaration \| CallSignatureDeclaration \| ClassStaticBlockDeclaration \| ConstructSignatureDeclaration \| MethodSignature \| PropertySignature \| ArrowFunction \| ParenthesizedExpression \| SpreadAssignment \| ShorthandPropertyAssignment \| PropertyAssignment \| FunctionExpression \| EmptyStatement \| DebuggerStatement \| Block \| VariableStatement \| ExpressionStatement \| IfStatement \| DoStatement \| WhileStatement \| ForStatement \| ForInStatement \| ForOfStatement \| BreakStatement \| ContinueStatement \| ReturnStatement \| WithStatement \| SwitchStatement \| LabeledStatement \| ThrowStatement \| TryStatement \| FunctionDeclaration \| ConstructorDeclaration \| MethodDeclaration \| VariableDeclaration \| PropertyDeclaration \| AccessorDeclaration \| ClassLikeDeclaration \| InterfaceDeclaration \| TypeAliasDeclaration \| EnumMember \| EnumDeclaration \| ModuleDeclaration \| ImportEqualsDeclaration \| ImportDeclaration \| NamespaceExportDeclaration \| ExportAssignment \| IndexSignatureDeclaration \| FunctionTypeNode \| ConstructorTypeNode \| JSDocFunctionType \| ExportDeclaration \| NamedTupleMember \| ExportSpecifier \| CaseClause \| EndOfFileToken;
`576`	`576`	`export type HasType = SignatureDeclaration \| VariableDeclaration \| ParameterDeclaration \| PropertySignature \| PropertyDeclaration \| TypePredicateNode \| ParenthesizedTypeNode \| TypeOperatorNode \| MappedTypeNode \| AssertionExpression \| TypeAliasDeclaration \| JSDocTypeExpression \| JSDocNonNullableType \| JSDocNullableType \| JSDocOptionalType \| JSDocVariadicType;`
`577`	`577`	`export type HasTypeArguments = CallExpression \| NewExpression \| TaggedTemplateExpression \| JsxOpeningElement \| JsxSelfClosingElement;`
`578`	`578`	`export type HasInitializer = HasExpressionInitializer \| ForStatement \| ForInStatement \| ForOfStatement \| JsxAttribute;`
`@@ -1498,7 +1498,7 @@ declare namespace ts {`
`1498`	`1498`	`readonly parent: SwitchStatement;`
`1499`	`1499`	`readonly clauses: NodeArray<CaseOrDefaultClause>;`
`1500`	`1500`	`}`
`1501`		`- export interface CaseClause extends Node {`
	`1501`	`+ export interface CaseClause extends Node, JSDocContainer {`
`1502`	`1502`	`readonly kind: SyntaxKind.CaseClause;`
`1503`	`1503`	`readonly parent: CaseBlock;`
`1504`	`1504`	`readonly expression: Expression;`