microsoft/TypeScript
1
0
Fork 0
mirror of https://github.com/microsoft/TypeScript.git synced 2026-03-03 09:19:49 -06:00
Code Issues Packages Projects Releases 212 Wiki Activity

Fix show deprecated suggestion for alias (#41128)

Browse Source 
* Fix show deprecated suggestion for alias

* Fix failing tests

* Avoid duplicated kind modifiers
This commit is contained in:
Jean Pierre 2020-11-23 18:50:12 -05:00 committed by GitHub
parent 669305b914
commit 71559a5c0c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 57 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/services/completions.ts
View File

@ -447,7 +447,7 @@ namespace ts.Completions {
return {
name,
kind: SymbolDisplay.getSymbolKind(typeChecker, symbol, location!), // TODO: GH#18217
kindModifiers: SymbolDisplay.getSymbolModifiers(symbol),
kindModifiers: SymbolDisplay.getSymbolModifiers(typeChecker, symbol),
sortText,
source: getSourceFromOrigin(origin),
hasAction: origin && originIsExport(origin) || undefined,
@ -697,7 +697,7 @@ namespace ts.Completions {
checker.runWithCancellationToken(cancellationToken, checker =>
SymbolDisplay.getSymbolDisplayPartsDocumentationAndSymbolKind(checker, symbol, sourceFile, location, location, SemanticMeaning.All)
);
return createCompletionDetails(symbol.name, SymbolDisplay.getSymbolModifiers(symbol), symbolKind, displayParts, documentation, tags, codeActions, sourceDisplay);
return createCompletionDetails(symbol.name, SymbolDisplay.getSymbolModifiers(checker, symbol), symbolKind, displayParts, documentation, tags, codeActions, sourceDisplay);
}
export function createCompletionDetails(name: string, kindModifiers: string, kind: ScriptElementKind, displayParts: SymbolDisplayPart[], documentation?: SymbolDisplayPart[], tags?: JSDocTagInfo[], codeActions?: CodeAction[], source?: SymbolDisplayPart[]): CompletionEntryDetails {

2
src/services/rename.ts
View File

@ -52,7 +52,7 @@ namespace ts.Rename {
: undefined;
const displayName = specifierName || typeChecker.symbolToString(symbol);
const fullDisplayName = specifierName || typeChecker.getFullyQualifiedName(symbol);
return getRenameInfoSuccess(displayName, fullDisplayName, kind, SymbolDisplay.getSymbolModifiers(symbol), node, sourceFile);
return getRenameInfoSuccess(displayName, fullDisplayName, kind, SymbolDisplay.getSymbolModifiers(typeChecker,symbol), node, sourceFile);
}
function getRenameInfoForModule(node: StringLiteralLike, sourceFile: SourceFile, moduleSymbol: Symbol): RenameInfo | undefined {

2
src/services/services.ts
View File

@ -1607,7 +1607,7 @@ namespace ts {
);
return {
kind: symbolKind,
kindModifiers: SymbolDisplay.getSymbolModifiers(symbol),
kindModifiers: SymbolDisplay.getSymbolModifiers(typeChecker, symbol),
textSpan: createTextSpanFromNode(nodeForQuickInfo, sourceFile),
displayParts,
documentation,

33
src/services/symbolDisplay.ts
View File

@ -102,15 +102,32 @@ namespace ts.SymbolDisplay {
return ScriptElementKind.unknown;
}
export function getSymbolModifiers(symbol: Symbol): string {
const nodeModifiers = symbol && symbol.declarations && symbol.declarations.length > 0
? getNodeModifiers(symbol.declarations[0])
: ScriptElementKindModifier.none;
export function getSymbolModifiers(typeChecker: TypeChecker, symbol: Symbol): string {
if (!symbol) {
return ScriptElementKindModifier.none;
}
const symbolModifiers = symbol && symbol.flags & SymbolFlags.Optional ?
ScriptElementKindModifier.optionalModifier
: ScriptElementKindModifier.none;
return nodeModifiers && symbolModifiers ? nodeModifiers + "," + symbolModifiers : nodeModifiers || symbolModifiers;
const modifiers = new Set<string>();
if (symbol.declarations && symbol.declarations.length > 0) {
const kindModifiers = getNodeModifiers(symbol.declarations[0]);
if (kindModifiers !== ScriptElementKindModifier.none) {
kindModifiers.split(",").forEach(m => modifiers.add(m));
}
}
if (symbol.flags & SymbolFlags.Alias) {
const resolvedSymbol = typeChecker.getAliasedSymbol(symbol);
if (resolvedSymbol !== symbol && resolvedSymbol.declarations && resolvedSymbol.declarations.length > 0) {
const kindModifiers = getNodeModifiers(resolvedSymbol.declarations[0]);
if (kindModifiers !== ScriptElementKindModifier.none) {
kindModifiers.split(",").forEach(m => modifiers.add(m));
}
}
}
if (symbol.flags & SymbolFlags.Optional) {
modifiers.add(ScriptElementKindModifier.optionalModifier);
}
return modifiers.size > 0 ? arrayFrom(modifiers.values()).join(",") : ScriptElementKindModifier.none;
}
interface SymbolDisplayPartsDocumentationAndSymbolKind {

4
tests/baselines/reference/quickInfoDisplayPartsInternalModuleAlias.baseline
View File

@ -160,7 +160,7 @@
},
"quickInfo": {
"kind": "alias",
"kindModifiers": "",
"kindModifiers": "export",
"textSpan": {
"start": 104,
"length": 2
@ -245,7 +245,7 @@
},
"quickInfo": {
"kind": "alias",
"kindModifiers": "",
"kindModifiers": "export",
"textSpan": {
"start": 123,
"length": 2

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

@ -11,7 +11,7 @@
verify.completions({
marker: "",
exact: [
{ name: "foo", kind: "alias", kindModifiers: "export", text: "(alias) const foo: number\nimport foo = N.foo" },
{ name: "foo", kind: "alias", kindModifiers: "export,declare", text: "(alias) const foo: number\nimport foo = N.foo" },
...completion.globalsPlus([{ name: "N", kind: "module", kindModifiers: "declare", text: "namespace N" }]),
],
});

3
tests/cases/fourslash/completionsImport_named_didNotExistBefore.ts
View File

@ -16,7 +16,8 @@ verify.completions({
{
name: "Test2",
text: "(alias) function Test2(): void\nimport Test2",
kind: "alias"
kind: "alias",
kindModifiers: "export"
},
completion.globalThisEntry,
completion.undefinedVarEntry,

1
tests/cases/fourslash/completionsImport_reExportDefault.ts
View File

@ -34,6 +34,7 @@ verify.completions({
sourceDisplay: "./a",
text: "(alias) function foo(): void\nexport foo",
kind: "alias",
kindModifiers: "export",
hasAction: true,
sortText: completion.SortText.AutoImportSuggestions
},

23
tests/cases/fourslash/completionsWithDeprecatedTag.ts
View File

@ -1,6 +1,13 @@
/// <reference path="fourslash.ts" />
// @strict: true
// @filename: /foobar.ts
//// /** @deprecated */
//// export function foobar() {}
// @filename: /foo.ts
//// import { foobar/*4*/ } from "./foobar";
////
//// /** @deprecated */
//// interface Foo {
//// /** @deprecated */
@ -12,6 +19,8 @@
//// declare const foooo: Fo/*1*/;
//// foo.ba/*2*/;
//// foo.pro/*3*/;
////
//// fooba/*5*/;
verify.completions({
marker: "1",
@ -28,5 +37,15 @@ verify.completions({
includes: [
{ name: "prop", kind: "property", kindModifiers: "deprecated" }
]
});
}, {
marker: "4",
includes: [
{ name: "foobar", kind: "function", kindModifiers: "export,deprecated" }
]
}, {
marker: "5",
includes: [
{ name: "foobar", kind: "alias", kindModifiers: "export,deprecated" }
]
}
);

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

@ -28,7 +28,7 @@
goTo.eachMarker((_, index) => {
verify.verifyQuickInfoDisplayParts(
"alias",
"",
"export",
{ start: index === 0 ? 25 : 117, length: 1 },
[
{ text:"(",kind:"punctuation" },