microsoft/TypeScript
1
0
Fork 0
mirror of https://github.com/microsoft/TypeScript.git synced 2026-05-15 21:36:50 -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("}"));