microsoft/TypeScript
1
0
Fork 0
mirror of https://github.com/microsoft/TypeScript.git synced 2026-05-09 07:55:10 -05:00
Code Issues Packages Projects Releases 212 Wiki Activity

fix(32941): include Template tag constraint to QuickInfo response (#47567)

Browse Source
This commit is contained in:
Oleksandr T
2022-02-05 02:12:23 +02:00
committed by GitHub
parent 3328feb799
commit 8ddead50eb
13 changed files with 889 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
src/services/jsDoc.ts
View File

@@ -169,7 +169,27 @@ namespace ts.JsDoc {
case SyntaxKind.JSDocAugmentsTag:
return withNode((tag as JSDocAugmentsTag).class);
case SyntaxKind.JSDocTemplateTag:
return addComment((tag as JSDocTemplateTag).typeParameters.map(tp => tp.getText()).join(", "));
const templateTag = tag as JSDocTemplateTag;
const displayParts: SymbolDisplayPart[] = [];
if (templateTag.constraint) {
displayParts.push(textPart(templateTag.constraint.getText()));
}
if (length(templateTag.typeParameters)) {
if (length(displayParts)) {
displayParts.push(spacePart());
}
const lastTypeParameter = templateTag.typeParameters[templateTag.typeParameters.length - 1];
forEach(templateTag.typeParameters, tp => {
displayParts.push(namePart(tp.getText()));
if (lastTypeParameter !== tp) {
displayParts.push(...[punctuationPart(SyntaxKind.CommaToken), spacePart()]);
}
});
}
if (comment) {
displayParts.push(...[spacePart(), ...getDisplayPartsFromComment(comment, checker)]);
}
return displayParts;
case SyntaxKind.JSDocTypeTag:
return withNode((tag as JSDocTypeTag).typeExpression);
case SyntaxKind.JSDocTypedefTag:

2
tests/baselines/reference/jsdocReturnsTag.baseline
View File

@@ -117,7 +117,7 @@
"text": [
{
"text": "T",
"kind": "text"
"kind": "typeParameterName"
}
]
},

177
tests/baselines/reference/quickInfoJsDocTags10.baseline Normal file
View File

@@ -0,0 +1,177 @@
[
{
"marker": {
"fileName": "/tests/cases/fourslash/quickInfoJsDocTags10.js",
"position": 80,
"name": ""
},
"quickInfo": {
"kind": "const",
"kindModifiers": "",
"textSpan": {
"start": 80,
"length": 3
},
"displayParts": [
{
"text": "const",
"kind": "keyword"
},
{
"text": " ",
"kind": "space"
},
{
"text": "foo",
"kind": "localName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "<",
"kind": "punctuation"
},
{
"text": "T1",
"kind": "typeParameterName"
},
{
"text": ",",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "T2",
"kind": "typeParameterName"
},
{
"text": ">",
"kind": "punctuation"
},
{
"text": "(",
"kind": "punctuation"
},
{
"text": "a",
"kind": "parameterName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "T1",
"kind": "typeParameterName"
},
{
"text": ",",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "b",
"kind": "parameterName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "any",
"kind": "keyword"
},
{
"text": ")",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "=>",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "void",
"kind": "keyword"
}
],
"documentation": [],
"tags": [
{
"name": "param",
"text": [
{
"text": "a",
"kind": "text"
}
]
},
{
"name": "param",
"text": [
{
"text": "a",
"kind": "text"
}
]
},
{
"name": "template",
"text": [
{
"text": "T1",
"kind": "typeParameterName"
},
{
"text": ",",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "T2",
"kind": "typeParameterName"
},
{
"text": " ",
"kind": "space"
},
{
"text": "Comment Text",
"kind": "text"
}
]
}
]
}
}
]

230
tests/baselines/reference/quickInfoJsDocTags11.baseline Normal file
View File

@@ -0,0 +1,230 @@
[
{
"marker": {
"fileName": "/tests/cases/fourslash/quickInfoJsDocTags11.js",
"position": 120,
"name": ""
},
"quickInfo": {
"kind": "const",
"kindModifiers": "",
"textSpan": {
"start": 120,
"length": 3
},
"displayParts": [
{
"text": "const",
"kind": "keyword"
},
{
"text": " ",
"kind": "space"
},
{
"text": "foo",
"kind": "localName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "<",
"kind": "punctuation"
},
{
"text": "T1",
"kind": "typeParameterName"
},
{
"text": " ",
"kind": "space"
},
{
"text": "extends",
"kind": "keyword"
},
{
"text": " ",
"kind": "space"
},
{
"text": "number",
"kind": "keyword"
},
{
"text": ",",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "T2",
"kind": "typeParameterName"
},
{
"text": " ",
"kind": "space"
},
{
"text": "extends",
"kind": "keyword"
},
{
"text": " ",
"kind": "space"
},
{
"text": "number",
"kind": "keyword"
},
{
"text": ">",
"kind": "punctuation"
},
{
"text": "(",
"kind": "punctuation"
},
{
"text": "a",
"kind": "parameterName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "T1",
"kind": "typeParameterName"
},
{
"text": ",",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "b",
"kind": "parameterName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "T2",
"kind": "typeParameterName"
},
{
"text": ")",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "=>",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "void",
"kind": "keyword"
}
],
"documentation": [],
"tags": [
{
"name": "param",
"text": [
{
"text": "a",
"kind": "text"
}
]
},
{
"name": "param",
"text": [
{
"text": "b",
"kind": "text"
}
]
},
{
"name": "template",
"text": [
{
"text": "{number}",
"kind": "text"
},
{
"text": " ",
"kind": "space"
},
{
"text": "T1",
"kind": "typeParameterName"
},
{
"text": " ",
"kind": "space"
},
{
"text": "Comment T1",
"kind": "text"
}
]
},
{
"name": "template",
"text": [
{
"text": "{number}",
"kind": "text"
},
{
"text": " ",
"kind": "space"
},
{
"text": "T2",
"kind": "typeParameterName"
},
{
"text": " ",
"kind": "space"
},
{
"text": "Comment T2",
"kind": "text"
}
]
}
]
}
}
]

100
tests/baselines/reference/quickInfoJsDocTags7.baseline Normal file
View File

@@ -0,0 +1,100 @@
[
{
"marker": {
"fileName": "/tests/cases/fourslash/quickInfoJsDocTags7.js",
"position": 116,
"name": ""
},
"quickInfo": {
"kind": "const",
"kindModifiers": "",
"textSpan": {
"start": 116,
"length": 3
},
"displayParts": [
{
"text": "const",
"kind": "keyword"
},
{
"text": " ",
"kind": "space"
},
{
"text": "foo",
"kind": "localName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "(",
"kind": "punctuation"
},
{
"text": "t",
"kind": "parameterName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "T",
"kind": "typeParameterName"
},
{
"text": ")",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "=>",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "number",
"kind": "keyword"
}
],
"documentation": [],
"tags": [
{
"name": "type",
"text": [
{
"text": "{(t: T) => number}",
"kind": "text"
}
]
},
{
"name": "template",
"text": [
{
"text": "T",
"kind": "typeParameterName"
}
]
}
]
}
}
]

108
tests/baselines/reference/quickInfoJsDocTags8.baseline Normal file
View File

@@ -0,0 +1,108 @@
[
{
"marker": {
"fileName": "/tests/cases/fourslash/quickInfoJsDocTags8.js",
"position": 122,
"name": ""
},
"quickInfo": {
"kind": "const",
"kindModifiers": "",
"textSpan": {
"start": 122,
"length": 3
},
"displayParts": [
{
"text": "const",
"kind": "keyword"
},
{
"text": " ",
"kind": "space"
},
{
"text": "foo",
"kind": "localName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "(",
"kind": "punctuation"
},
{
"text": "t",
"kind": "parameterName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "T",
"kind": "typeParameterName"
},
{
"text": ")",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "=>",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "number",
"kind": "keyword"
}
],
"documentation": [],
"tags": [
{
"name": "type",
"text": [
{
"text": "{(t: T) => number}",
"kind": "text"
}
]
},
{
"name": "template",
"text": [
{
"text": "{Foo}",
"kind": "text"
},
{
"text": " ",
"kind": "space"
},
{
"text": "T",
"kind": "typeParameterName"
}
]
}
]
}
}
]

116
tests/baselines/reference/quickInfoJsDocTags9.baseline Normal file
View File

@@ -0,0 +1,116 @@
[
{
"marker": {
"fileName": "/tests/cases/fourslash/quickInfoJsDocTags9.js",
"position": 135,
"name": ""
},
"quickInfo": {
"kind": "const",
"kindModifiers": "",
"textSpan": {
"start": 135,
"length": 3
},
"displayParts": [
{
"text": "const",
"kind": "keyword"
},
{
"text": " ",
"kind": "space"
},
{
"text": "foo",
"kind": "localName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "(",
"kind": "punctuation"
},
{
"text": "t",
"kind": "parameterName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "T",
"kind": "typeParameterName"
},
{
"text": ")",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "=>",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "number",
"kind": "keyword"
}
],
"documentation": [],
"tags": [
{
"name": "type",
"text": [
{
"text": "{(t: T) => number}",
"kind": "text"
}
]
},
{
"name": "template",
"text": [
{
"text": "{Foo}",
"kind": "text"
},
{
"text": " ",
"kind": "space"
},
{
"text": "T",
"kind": "typeParameterName"
},
{
"text": " ",
"kind": "space"
},
{
"text": "Comment Text",
"kind": "text"
}
]
}
]
}
}
]

64
tests/baselines/reference/signatureHelpTypeArguments2.baseline
View File

@@ -213,7 +213,7 @@
"text": [
{
"text": "W",
"kind": "text"
"kind": "typeParameterName"
}
]
},
@@ -221,7 +221,19 @@
"name": "template",
"text": [
{
"text": "U, V",
"text": "U",
"kind": "typeParameterName"
},
{
"text": ",",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "V",
"kind": "typeParameterName"
},
{
@@ -494,7 +506,7 @@
"text": [
{
"text": "W",
"kind": "text"
"kind": "typeParameterName"
}
]
},
@@ -502,7 +514,19 @@
"name": "template",
"text": [
{
"text": "U, V",
"text": "U",
"kind": "typeParameterName"
},
{
"text": ",",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "V",
"kind": "typeParameterName"
},
{
@@ -775,7 +799,7 @@
"text": [
{
"text": "W",
"kind": "text"
"kind": "typeParameterName"
}
]
},
@@ -783,7 +807,19 @@
"name": "template",
"text": [
{
"text": "U, V",
"text": "U",
"kind": "typeParameterName"
},
{
"text": ",",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "V",
"kind": "typeParameterName"
},
{
@@ -1056,7 +1092,7 @@
"text": [
{
"text": "W",
"kind": "text"
"kind": "typeParameterName"
}
]
},
@@ -1064,7 +1100,19 @@
"name": "template",
"text": [
{
"text": "U, V",
"text": "U",
"kind": "typeParameterName"
},
{
"text": ",",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "V",
"kind": "typeParameterName"
},
{

14
tests/cases/fourslash/quickInfoJsDocTags10.ts Normal file
View File

@@ -0,0 +1,14 @@
/// <reference path="fourslash.ts" />
// @noEmit: true
// @allowJs: true
// @Filename: quickInfoJsDocTags10.js
/////**
//// * @param {T1} a
//// * @param {T2} a
//// * @template T1,T2 Comment Text
//// */
////const /**/foo = (a, b) => {};
verify.baselineQuickInfo();

15
tests/cases/fourslash/quickInfoJsDocTags11.ts Normal file
View File

@@ -0,0 +1,15 @@
/// <reference path="fourslash.ts" />
// @noEmit: true
// @allowJs: true
// @Filename: quickInfoJsDocTags11.js
/////**
//// * @param {T1} a
//// * @param {T2} b
//// * @template {number} T1 Comment T1
//// * @template {number} T2 Comment T2
//// */
////const /**/foo = (a, b) => {};
verify.baselineQuickInfo();

17
tests/cases/fourslash/quickInfoJsDocTags7.ts Normal file
View File

@@ -0,0 +1,17 @@
/// <reference path="fourslash.ts" />
// @noEmit: true
// @allowJs: true
// @Filename: quickInfoJsDocTags7.js
/////**
//// * @typedef {{ [x: string]: any, y: number }} Foo
//// */
////
/////**
//// * @type {(t: T) => number}
//// * @template T
//// */
////const /**/foo = t => t.y;
verify.baselineQuickInfo();

17
tests/cases/fourslash/quickInfoJsDocTags8.ts Normal file
View File

@@ -0,0 +1,17 @@
/// <reference path="fourslash.ts" />
// @noEmit: true
// @allowJs: true
// @Filename: quickInfoJsDocTags8.js
/////**
//// * @typedef {{ [x: string]: any, y: number }} Foo
//// */
////
/////**
//// * @type {(t: T) => number}
//// * @template {Foo} T
//// */
////const /**/foo = t => t.y;
verify.baselineQuickInfo();

17
tests/cases/fourslash/quickInfoJsDocTags9.ts Normal file
View File

@@ -0,0 +1,17 @@
/// <reference path="fourslash.ts" />
// @noEmit: true
// @allowJs: true
// @Filename: quickInfoJsDocTags9.js
/////**
//// * @typedef {{ [x: string]: any, y: number }} Foo
//// */
////
/////**
//// * @type {(t: T) => number}
//// * @template {Foo} T Comment Text
//// */
////const /**/foo = t => t.y;
verify.baselineQuickInfo();