microsoft/TypeScript
1
0
Fork 0
mirror of https://github.com/microsoft/TypeScript.git synced 2026-02-12 21:37:41 -06:00
Code Issues Packages Projects Releases 212 Wiki Activity

quickInfo: Get JSDoc tags from aliased symbol (#23526)

Browse Source 
* quickInfo: Get JSDoc tags from aliased symbol

* Add test with existing tags
This commit is contained in:
Andy 2018-04-19 15:33:36 -07:00 committed by GitHub
parent 7d6d7b0b4e
commit bc7979c174
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 57 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/services/symbolDisplay.ts
View File

@ -134,6 +134,7 @@ namespace ts.SymbolDisplay {
let type: Type;
let printer: Printer;
let documentationFromAlias: SymbolDisplayPart[];
let tagsFromAlias: JSDocTagInfo[];
// Class at constructor site need to be shown as constructor apart from property,method, vars
if (symbolKind !== ScriptElementKind.unknown || symbolFlags & SymbolFlags.Class || symbolFlags & SymbolFlags.Alias) {
@ -396,6 +397,7 @@ namespace ts.SymbolDisplay {
displayParts.push(...resolvedInfo.displayParts);
displayParts.push(lineBreakPart());
documentationFromAlias = resolvedInfo.documentation;
tagsFromAlias = resolvedInfo.tags;
}
}
}
@ -521,6 +523,9 @@ namespace ts.SymbolDisplay {
if (documentation.length === 0 && documentationFromAlias) {
documentation = documentationFromAlias;
}
if (tags.length === 0 && tagsFromAlias) {
tags = tagsFromAlias;
}
return { displayParts, documentation, symbolKind, tags };

2
tests/cases/fourslash/fourslash.ts
View File

@ -338,7 +338,7 @@ declare namespace FourSlashInterface {
verifyQuickInfoDisplayParts(kind: string, kindModifiers: string, textSpan: {
start: number;
length: number;
}, displayParts: ts.SymbolDisplayPart[], documentation: ts.SymbolDisplayPart[], tags: ts.JSDocTagInfo[]): void;
}, displayParts: ts.SymbolDisplayPart[], documentation: ts.SymbolDisplayPart[], tags: { name: string, text?: string }[]): void;
getSyntacticDiagnostics(expected: ReadonlyArray<Diagnostic>): void;
getSemanticDiagnostics(expected: ReadonlyArray<Diagnostic>): void;
getSuggestionDiagnostics(expected: ReadonlyArray<Diagnostic>): void;

51
tests/cases/fourslash/quickInfoAlias.ts Normal file
View File

@ -0,0 +1,51 @@
/// <reference path='fourslash.ts'/>
// @Filename: /a.ts
/////**
//// * Doc
//// * @tag Tag text
//// */
////export const x = 0;
// @Filename: /b.ts
////import { x } from "./a";
////x/*b*/;
// @Filename: /c.ts
/////**
//// * Doc 2
//// * @tag Tag text 2
//// */
////import {
//// /**
//// * Doc 3
//// * @tag Tag text 3
//// */
//// x
////} from "./a";
////x/*c*/;
goTo.eachMarker((_, index) => {
verify.verifyQuickInfoDisplayParts(
"alias",
"",
{ start: index === 0 ? 25 : 117, length: 1 },
[
{ text:"(",kind:"punctuation" },
{ text:"alias",kind:"text" },
{ text:")",kind:"punctuation" },
{ text:" ",kind:"space" },
{ text:"const",kind:"keyword" },
{ text:" ",kind:"space" },
{ text:"x",kind:"aliasName" },
{ text:":",kind:"punctuation" },
{ text:" ",kind:"space" },
{ text:"0",kind:"stringLiteral" },
{ text:"\n",kind:"lineBreak" },
{ text:"import",kind:"keyword" },
{ text:" ",kind:"space" },
{ text:"x",kind:"aliasName" },
],
[{ text: "Doc", kind: "text" }],
[{ name: "tag", text: "Tag text" }]);
});