microsoft/TypeScript
1
0
Fork 0
mirror of https://github.com/microsoft/TypeScript.git synced 2026-05-14 18:39:19 -05:00
Code Issues Packages Projects Releases 212 Wiki Activity

@link: format trailing () as part of linkName (#46428)

Browse Source 
Parsing separates the identifier part of the link tag from its text, but
the editor should present an identifier followed by `()` as a single
identifier since people use that syntax as a function sigil.

I prefer `#'` personally, you know, xkcd 297, nudge nudge.
This commit is contained in:
Nathan Shively-Sanders
2021-10-20 08:36:40 -07:00
committed by GitHub
parent 48e96f56be
commit 98b4ac2cde
6 changed files with 341 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
src/services/utilities.ts
View File

@@ -2290,9 +2290,9 @@ namespace ts {
return displayPart(text, SymbolDisplayPartKind.linkText);
}
export function linkNamePart(name: EntityName | JSDocMemberName, target: Declaration): JSDocLinkDisplayPart {
export function linkNamePart(text: string, target: Declaration): JSDocLinkDisplayPart {
return {
text: getTextOfNode(name),
text,
kind: SymbolDisplayPartKind[SymbolDisplayPartKind.linkName],
target: {
fileName: getSourceFileOfNode(target).fileName,
@@ -2315,13 +2315,16 @@ namespace ts {
}
else {
const symbol = checker?.getSymbolAtLocation(link.name);
const trailingParen = link.text.indexOf("()") === 0;
const name = getTextOfNode(link.name) + (trailingParen ? "()" : "");
const text = trailingParen ? link.text.slice(2) : link.text;
const decl = symbol?.valueDeclaration || symbol?.declarations?.[0];
if (decl) {
parts.push(linkNamePart(link.name, decl));
if (link.text) parts.push(linkTextPart(link.text));
parts.push(linkNamePart(name, decl));
if (text) parts.push(linkTextPart(text));
}
else {
parts.push(linkTextPart(getTextOfNode(link.name) + " " + link.text));
parts.push(linkTextPart(name + (trailingParen ? "" : " ") + text));
}
}
parts.push(linkPart("}"));

6
tests/baselines/reference/jsdocLink1.baseline
View File

@@ -107,7 +107,7 @@
"kind": "link"
},
{
"text": "C",
"text": "C()",
"kind": "linkName",
"target": {
"fileName": "/tests/cases/fourslash/jsdocLink1.ts",
@@ -117,10 +117,6 @@
}
}
},
{
"text": "()",
"kind": "linkText"
},
{
"text": "}",
"kind": "link"

6
tests/baselines/reference/jsdocLink2.baseline
View File

@@ -107,7 +107,7 @@
"kind": "link"
},
{
"text": "C",
"text": "C()",
"kind": "linkName",
"target": {
"fileName": "/tests/cases/fourslash/jsdocLink2.ts",
@@ -117,10 +117,6 @@
}
}
},
{
"text": "()",
"kind": "linkText"
},
{
"text": "}",
"kind": "link"

6
tests/baselines/reference/jsdocLink3.baseline
View File

@@ -107,7 +107,7 @@
"kind": "link"
},
{
"text": "C",
"text": "C()",
"kind": "linkName",
"target": {
"fileName": "/jsdocLink3.ts",
@@ -117,10 +117,6 @@
}
}
},
{
"text": "()",
"kind": "linkText"
},
{
"text": "}",
"kind": "link"

319
tests/baselines/reference/jsdocLink5.baseline Normal file
View File

@@ -0,0 +1,319 @@
[
{
"marker": {
"fileName": "/tests/cases/fourslash/jsdocLink5.ts",
"position": 210,
"name": "3"
},
"quickInfo": {
"kind": "function",
"kindModifiers": "",
"textSpan": {
"start": 209,
"length": 1
},
"displayParts": [
{
"text": "function",
"kind": "keyword"
},
{
"text": " ",
"kind": "space"
},
{
"text": "f",
"kind": "functionName"
},
{
"text": "(",
"kind": "punctuation"
},
{
"text": "x",
"kind": "parameterName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "any",
"kind": "keyword"
},
{
"text": ")",
"kind": "punctuation"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "void",
"kind": "keyword"
}
],
"documentation": [
{
"text": "",
"kind": "text"
},
{
"text": "{@link ",
"kind": "link"
},
{
"text": "g()",
"kind": "linkName",
"target": {
"fileName": "/tests/cases/fourslash/jsdocLink5.ts",
"textSpan": {
"start": 0,
"length": 16
}
}
},
{
"text": "}",
"kind": "link"
},
{
"text": " ",
"kind": "text"
},
{
"text": "{@link ",
"kind": "link"
},
{
"text": "g()",
"kind": "linkName",
"target": {
"fileName": "/tests/cases/fourslash/jsdocLink5.ts",
"textSpan": {
"start": 0,
"length": 16
}
}
},
{
"text": " ",
"kind": "linkText"
},
{
"text": "}",
"kind": "link"
},
{
"text": " ",
"kind": "text"
},
{
"text": "{@link ",
"kind": "link"
},
{
"text": "g()",
"kind": "linkName",
"target": {
"fileName": "/tests/cases/fourslash/jsdocLink5.ts",
"textSpan": {
"start": 0,
"length": 16
}
}
},
{
"text": "}",
"kind": "link"
},
{
"text": " ",
"kind": "text"
},
{
"text": "{@link ",
"kind": "link"
},
{
"text": "g()",
"kind": "linkName",
"target": {
"fileName": "/tests/cases/fourslash/jsdocLink5.ts",
"textSpan": {
"start": 0,
"length": 16
}
}
},
{
"text": " 0",
"kind": "linkText"
},
{
"text": "}",
"kind": "link"
},
{
"text": " ",
"kind": "text"
},
{
"text": "{@link ",
"kind": "link"
},
{
"text": "g()",
"kind": "linkName",
"target": {
"fileName": "/tests/cases/fourslash/jsdocLink5.ts",
"textSpan": {
"start": 0,
"length": 16
}
}
},
{
"text": "1",
"kind": "linkText"
},
{
"text": "}",
"kind": "link"
},
{
"text": " ",
"kind": "text"
},
{
"text": "{@link ",
"kind": "link"
},
{
"text": "g()",
"kind": "linkName",
"target": {
"fileName": "/tests/cases/fourslash/jsdocLink5.ts",
"textSpan": {
"start": 0,
"length": 16
}
}
},
{
"text": " 2",
"kind": "linkText"
},
{
"text": "}",
"kind": "link"
},
{
"text": "\n",
"kind": "text"
},
{
"text": "{@link ",
"kind": "link"
},
{
"text": "u()",
"kind": "linkText"
},
{
"text": "}",
"kind": "link"
},
{
"text": " ",
"kind": "text"
},
{
"text": "{@link ",
"kind": "link"
},
{
"text": "u() ",
"kind": "linkText"
},
{
"text": "}",
"kind": "link"
},
{
"text": " ",
"kind": "text"
},
{
"text": "{@link ",
"kind": "link"
},
{
"text": "u()",
"kind": "linkText"
},
{
"text": "}",
"kind": "link"
},
{
"text": " ",
"kind": "text"
},
{
"text": "{@link ",
"kind": "link"
},
{
"text": "u() 0",
"kind": "linkText"
},
{
"text": "}",
"kind": "link"
},
{
"text": " ",
"kind": "text"
},
{
"text": "{@link ",
"kind": "link"
},
{
"text": "u()1",
"kind": "linkText"
},
{
"text": "}",
"kind": "link"
},
{
"text": " ",
"kind": "text"
},
{
"text": "{@link ",
"kind": "link"
},
{
"text": "u() 2",
"kind": "linkText"
},
{
"text": "}",
"kind": "link"
}
]
}
}
]

11
tests/cases/fourslash/jsdocLink5.ts Normal file
View File

@@ -0,0 +1,11 @@
///<reference path="fourslash.ts" />
//// function g() { }
//// /**
//// * {@link g()} {@link g() } {@link g ()} {@link g () 0} {@link g()1} {@link g() 2}
//// * {@link u()} {@link u() } {@link u ()} {@link u () 0} {@link u()1} {@link u() 2}
//// */
//// function f(x) {
//// }
//// f/*3*/()
verify.baselineQuickInfo();