Skip to content

Fix modifier order for class member completions #48066

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 1, 2022
Merged

Fix modifier order for class member completions #48066

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3c3934f
fix modifier order & tests
gabritto Feb 28, 2022
103f9a3
remove empty replacement span from tests
gabritto Feb 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 16 additions & 15 deletions src/services/completions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -768,7 +768,7 @@ namespace ts.Completions {
completionKind === CompletionKind.MemberLike &&
isClassLikeMemberCompletion(symbol, location)) {
let importAdder;
({ insertText, isSnippet, importAdder } = getEntryForMemberCompletion(host, program, options, preferences, name, symbol, location, contextToken, formatContext));
({ insertText, isSnippet, importAdder, replacementSpan } = getEntryForMemberCompletion(host, program, options, preferences, name, symbol, location, contextToken, formatContext));
if (importAdder?.hasFixes()) {
hasAction = true;
source = CompletionSource.ClassMemberSnippet;
Expand Down Expand Up @@ -894,13 +894,14 @@ namespace ts.Completions {
location: Node,
contextToken: Node | undefined,
formatContext: formatting.FormatContext | undefined,
): { insertText: string, isSnippet?: true, importAdder?: codefix.ImportAdder } {
): { insertText: string, isSnippet?: true, importAdder?: codefix.ImportAdder, replacementSpan?: TextSpan } {
const classLikeDeclaration = findAncestor(location, isClassLike);
if (!classLikeDeclaration) {
return { insertText: name };
}

let isSnippet: true | undefined;
let replacementSpan: TextSpan | undefined;
let insertText: string = name;

const checker = program.getTypeChecker();
Expand Down Expand Up @@ -932,10 +933,8 @@ namespace ts.Completions {
let modifiers = ModifierFlags.None;
// Whether the suggested member should be abstract.
// e.g. in `abstract class C { abstract | }`, we should offer abstract method signatures at position `|`.
// Note: We are relying on checking if the context token is `abstract`,
// since other visibility modifiers (e.g. `protected`) should come *before* `abstract`.
// However, that is not true for the e.g. `override` modifier, so this check has its limitations.
const isAbstract = contextToken && isModifierLike(contextToken) === SyntaxKind.AbstractKeyword;
const { modifiers: presentModifiers, span: modifiersSpan } = getPresentModifiers(contextToken);
const isAbstract = !!(presentModifiers & ModifierFlags.Abstract);
const completionNodes: Node[] = [];
codefix.addNewNodeForMemberSymbol(
symbol,
Expand All @@ -961,26 +960,22 @@ namespace ts.Completions {
requiredModifiers |= ModifierFlags.Override;
}

let presentModifiers = ModifierFlags.None;
if (!completionNodes.length) {
// Omit already present modifiers from the first completion node/signature.
if (contextToken) {
presentModifiers = getPresentModifiers(contextToken);
}
// Keep track of added missing required modifiers and modifiers already present.
// This is needed when we have overloaded signatures,
// so this callback will be called for multiple nodes/signatures,
// and we need to make sure the modifiers are uniform for all nodes/signatures.
modifiers = node.modifierFlagsCache | requiredModifiers | presentModifiers;
}
node = factory.updateModifiers(node, modifiers & (~presentModifiers));
node = factory.updateModifiers(node, modifiers);
completionNodes.push(node);
},
body,
codefix.PreserveOptionalFlags.Property,
isAbstract);

if (completionNodes.length) {
replacementSpan = modifiersSpan;
// If we have access to formatting settings, we print the nodes using the emitter,
// and then format the printed text.
if (formatContext) {
Expand Down Expand Up @@ -1015,11 +1010,15 @@ namespace ts.Completions {
}
}

return { insertText, isSnippet, importAdder };
return { insertText, isSnippet, importAdder, replacementSpan };
}

function getPresentModifiers(contextToken: Node): ModifierFlags {
function getPresentModifiers(contextToken: Node | undefined): { modifiers: ModifierFlags, span?: TextSpan } {
if (!contextToken) {
return { modifiers: ModifierFlags.None };
}
let modifiers = ModifierFlags.None;
let span;
let contextMod;
/*
Cases supported:
Expand All @@ -1042,11 +1041,13 @@ namespace ts.Completions {
*/
if (contextMod = isModifierLike(contextToken)) {
modifiers |= modifierToFlag(contextMod);
span = createTextSpanFromNode(contextToken);
}
if (isPropertyDeclaration(contextToken.parent)) {
modifiers |= modifiersToFlags(contextToken.parent.modifiers);
span = createTextSpanFromNode(contextToken.parent);
}
return modifiers;
return { modifiers, span };
}

function isModifierLike(node: Node): ModifierSyntaxKind | undefined {
Expand Down
55 changes: 3 additions & 52 deletions tests/cases/fourslash/completionsOverridingMethod.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@
////
////class HSub extends HBase {
//// /*h1*/
//// static /*h2*/
//// [|static|] /*h2*/
////}

// @Filename: i.ts
Expand Down Expand Up @@ -124,11 +124,6 @@ verify.completions({
{
name: "foo",
sortText: completion.SortText.LocationPriority,
replacementSpan: {
fileName: "",
pos: 0,
end: 0,
},
insertText: "foo(param1: string, param2: boolean): Promise<void> {\n}",
}
],
Expand All @@ -146,11 +141,6 @@ verify.completions({
{
name: "foo",
sortText: completion.SortText.LocationPriority,
replacementSpan: {
fileName: "",
pos: 0,
end: 0,
},
insertText: "foo(a: string, b: string): string {\n}",
}
],
Expand All @@ -168,11 +158,6 @@ verify.completions({
{
name: "foo",
sortText: completion.SortText.LocationPriority,
replacementSpan: {
fileName: "",
pos: 0,
end: 0,
},
insertText: "foo(a: string): string {\n}",
}
],
Expand All @@ -190,11 +175,6 @@ verify.completions({
{
name: "foo",
sortText: completion.SortText.LocationPriority,
replacementSpan: {
fileName: "",
pos: 0,
end: 0,
},
insertText: "foo(a: string): string {\n}",
}
],
Expand All @@ -212,11 +192,6 @@ verify.completions({
{
name: "foo",
sortText: completion.SortText.LocationPriority,
replacementSpan: {
fileName: "",
pos: 0,
end: 0,
},
insertText: "foo(a: string): string {\n}",
}
],
Expand All @@ -234,11 +209,6 @@ verify.completions({
{
name: "foo",
sortText: completion.SortText.LocationPriority,
replacementSpan: {
fileName: "",
pos: 0,
end: 0,
},
insertText: "foo(a: string): string {\n}",
}
],
Expand All @@ -256,11 +226,6 @@ verify.completions({
{
name: "foo",
sortText: completion.SortText.LocationPriority,
replacementSpan: {
fileName: "",
pos: 0,
end: 0,
},
insertText:
`foo(a: string): string;
foo(a: undefined, b: number): string;
Expand Down Expand Up @@ -292,12 +257,8 @@ verify.completions({
{
name: "met",
sortText: completion.SortText.LocationPriority,
replacementSpan: {
fileName: "",
pos: 0,
end: 0,
},
insertText: "met(n: number): number {\n}",
replacementSpan: test.ranges()[0],
insertText: "static met(n: number): number {\n}",
}
],
});
Expand All @@ -314,21 +275,11 @@ verify.completions({
{
name: "met",
sortText: completion.SortText.LocationPriority,
replacementSpan: {
fileName: "",
pos: 0,
end: 0,
},
insertText: "met<T>(t: T): T {\n}",
},
{
name: "metcons",
sortText: completion.SortText.LocationPriority,
replacementSpan: {
fileName: "",
pos: 0,
end: 0,
},
insertText: "metcons<T extends string | number>(t: T): T {\n}",
}
],
Expand Down
5 changes: 0 additions & 5 deletions tests/cases/fourslash/completionsOverridingMethod1.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,6 @@ verify.completions({
{
name: "foo",
sortText: completion.SortText.LocationPriority,
replacementSpan: {
fileName: "",
pos: 0,
end: 0,
},
insertText: "override foo(a: string): void {\n}",
}
],
Expand Down
15 changes: 0 additions & 15 deletions tests/cases/fourslash/completionsOverridingMethod10.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,33 +26,18 @@ verify.completions({
{
name: "a",
sortText: completion.SortText.LocationPriority,
replacementSpan: {
fileName: "",
pos: 0,
end: 0,
},
insertText: "a: string;",
},
{
name: "b",
sortText: completion.SortText.LocationPriority,
replacementSpan: {
fileName: "",
pos: 0,
end: 0,
},
insertText:
`b(a: string): void {
}`,
},
{
name: "c",
sortText: completion.SortText.LocationPriority,
replacementSpan: {
fileName: "",
pos: 0,
end: 0,
},
insertText:
`c(a: string): string;
c(a: number): number;
Expand Down
15 changes: 0 additions & 15 deletions tests/cases/fourslash/completionsOverridingMethod11.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,33 +32,18 @@ verify.completions({
{
name: "a",
sortText: completion.SortText.LocationPriority,
replacementSpan: {
fileName: "",
pos: 0,
end: 0,
},
insertText: "a: string",
},
{
name: "b",
sortText: completion.SortText.LocationPriority,
replacementSpan: {
fileName: "",
pos: 0,
end: 0,
},
insertText:
`b(a: string): void {
}`,
},
{
name: "c",
sortText: completion.SortText.LocationPriority,
replacementSpan: {
fileName: "",
pos: 0,
end: 0,
},
insertText:
`c(a: string): string
c(a: number): number
Expand Down
54 changes: 54 additions & 0 deletions tests/cases/fourslash/completionsOverridingMethod12.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
/// <reference path="fourslash.ts" />

// @Filename: a.ts
// @newline: LF
// Case: modifier order
////abstract class A {
//// public get P(): string {
//// return "";
//// }
////}
////
////abstract class B extends A {
//// [|abstract|] /*a*/
////}
////
////abstract class B1 extends A {
//// [|abstract override|] /*b*/
////}

verify.completions({
marker: "a",
isNewIdentifierLocation: true,
preferences: {
includeCompletionsWithInsertText: true,
includeCompletionsWithSnippetText: false,
includeCompletionsWithClassMemberSnippets: true,
},
includes: [
{
name: "P",
sortText: completion.SortText.LocationPriority,
replacementSpan: test.ranges()[0],
insertText: "public abstract get P(): string;",
},
],
});

verify.completions({
marker: "b",
isNewIdentifierLocation: true,
preferences: {
includeCompletionsWithInsertText: true,
includeCompletionsWithSnippetText: false,
includeCompletionsWithClassMemberSnippets: true,
},
includes: [
{
name: "P",
sortText: completion.SortText.LocationPriority,
replacementSpan: test.ranges()[1],
insertText: "public abstract override get P(): string;",
},
],
});
5 changes: 0 additions & 5 deletions tests/cases/fourslash/completionsOverridingMethod2.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,6 @@ verify.completions({
{
name: "$usd",
sortText: completion.SortText.LocationPriority,
replacementSpan: {
fileName: "",
pos: 0,
end: 0,
},
isSnippet: true,
insertText: "\"\\$usd\"(a: number): number {\n $0\n}",
}
Expand Down
5 changes: 0 additions & 5 deletions tests/cases/fourslash/completionsOverridingMethod3.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,6 @@ verify.completions({
{
name: "boo",
sortText: completion.SortText.LocationPriority,
replacementSpan: {
fileName: "",
pos: 0,
end: 0,
},
insertText: "boo(): string;",
}
],
Expand Down
Loading