support both label details and non-label details in object literal method snippets

Author: gabritto

src/services/completions.ts

@@ -782,6 +782,10 @@ namespace ts.Completions {
         if (origin && originIsObjectLiteralMethod(origin)) {
             let importAdder;
             ({ insertText, isSnippet, importAdder, labelDetails } = origin);
+            if (!preferences.includeCompletionsWithLabelDetails) {
+                name = name + labelDetails.detail;
+                labelDetails = undefined;
+            }
             source = CompletionSource.ObjectLiteralMethodSnippet;
             sortText = SortText.SortBelow(sortText);
             if (importAdder.hasFixes()) {

tests/cases/fourslash/completionsObjectLiteralMethod1.ts

@@ -38,6 +38,7 @@ verify.completions({
         includeCompletionsWithInsertText: true,
         includeCompletionsWithSnippetText: false,
         includeCompletionsWithObjectLiteralMethodSnippets: true,
+        includeCompletionsWithLabelDetails: true,
     },
     includes: [
         {
@@ -51,6 +52,9 @@ verify.completions({
                 completion.SortText.ObjectLiteralProperty(completion.SortText.LocationPriority, "bar")),
             source: completion.CompletionSource.ObjectLiteralMethodSnippet,
             insertText: "bar(x: number): void {\n},",
+            labelDetails: {
+                detail: "(x: number): void",
+            },
         },
     ],
 });
@@ -60,6 +64,7 @@ verify.completions({
         includeCompletionsWithInsertText: true,
         includeCompletionsWithSnippetText: false,
         includeCompletionsWithObjectLiteralMethodSnippets: true,
+        includeCompletionsWithLabelDetails: true,
     },
     includes: [
         {
@@ -73,6 +78,9 @@ verify.completions({
                 completion.SortText.ObjectLiteralProperty(completion.SortText.LocationPriority, "bar")),
             source: completion.CompletionSource.ObjectLiteralMethodSnippet,
             insertText: "bar(x: number): void {\n},",
+            labelDetails: {
+                detail: "(x: number): void",
+            },
         },
         {
             name: "foo",
@@ -85,6 +93,9 @@ verify.completions({
                 completion.SortText.ObjectLiteralProperty(completion.SortText.LocationPriority, "foo")),
             source: completion.CompletionSource.ObjectLiteralMethodSnippet,
             insertText: "foo(x: string): string {\n},",
+            labelDetails: {
+                detail: "(x: string): string",
+            },
         },
     ],
 });
@@ -110,6 +121,7 @@ verify.completions({
         includeCompletionsWithInsertText: true,
         includeCompletionsWithSnippetText: false,
         includeCompletionsWithObjectLiteralMethodSnippets: true,
+        includeCompletionsWithLabelDetails: true,
     },
     includes: [
         {
@@ -123,6 +135,9 @@ verify.completions({
                 completion.SortText.ObjectLiteralProperty(completion.SortText.LocationPriority, "\"space bar\"")),
             source: completion.CompletionSource.ObjectLiteralMethodSnippet,
             insertText: "\"space bar\"(): string {\n},",
+            labelDetails: {
+                detail: "(): string",
+            },
         },
     ],
 });
@@ -132,6 +147,7 @@ verify.completions({
         includeCompletionsWithInsertText: true,
         includeCompletionsWithSnippetText: true,
         includeCompletionsWithObjectLiteralMethodSnippets: true,
+        includeCompletionsWithLabelDetails: true,
     },
     includes: [
         {
@@ -146,6 +162,33 @@ verify.completions({
             source: completion.CompletionSource.ObjectLiteralMethodSnippet,
             isSnippet: true,
             insertText: "bar(x: number): void {\n    $0\n},",
+            labelDetails: {
+                detail: "(x: number): void",
+            },
+        },
+    ],
+});
+verify.completions({
+    marker: "a",
+    preferences: {
+        includeCompletionsWithInsertText: true,
+        includeCompletionsWithSnippetText: true,
+        includeCompletionsWithObjectLiteralMethodSnippets: true,
+        includeCompletionsWithLabelDetails: false,
+    },
+    includes: [
+        {
+            name: "bar",
+            sortText: completion.SortText.ObjectLiteralProperty(completion.SortText.LocationPriority, "bar"),
+            insertText: undefined,
+        },
+        {
+            name: "bar(x: number): void",
+            sortText: completion.SortText.SortBelow(
+                completion.SortText.ObjectLiteralProperty(completion.SortText.LocationPriority, "bar")),
+            source: completion.CompletionSource.ObjectLiteralMethodSnippet,
+            isSnippet: true,
+            insertText: "bar(x: number): void {\n    $0\n},",
         },
     ],
 });

tests/cases/fourslash/completionsObjectLiteralMethod2.ts

@@ -24,6 +24,7 @@ verify.completions({
         includeCompletionsWithInsertText: true,
         includeCompletionsWithSnippetText: false,
         includeCompletionsWithObjectLiteralMethodSnippets: true,
+        includeCompletionsWithLabelDetails: true,
     },
     includes: [
         {
@@ -38,6 +39,9 @@ verify.completions({
             source: completion.CompletionSource.ObjectLiteralMethodSnippet,
             insertText: "foo(f: IFoo): void {\n},",
             hasAction: true,
+            labelDetails: {
+                detail: "(f: IFoo): void",
+            },
         },
     ],
 });
@@ -47,6 +51,7 @@ verify.applyCodeActionFromCompletion("a", {
         includeCompletionsWithInsertText: true,
         includeCompletionsWithSnippetText: false,
         includeCompletionsWithObjectLiteralMethodSnippets: true,
+        includeCompletionsWithLabelDetails: true,
     },
     name: "foo",
     source: completion.CompletionSource.ObjectLiteralMethodSnippet,

tests/cases/fourslash/completionsObjectLiteralMethod3.ts

@@ -39,6 +39,7 @@ verify.completions({
         includeCompletionsWithInsertText: true,
         includeCompletionsWithSnippetText: false,
         includeCompletionsWithObjectLiteralMethodSnippets: true,
+        includeCompletionsWithLabelDetails: true,
     },
     includes: [
         {
@@ -52,6 +53,9 @@ verify.completions({
                 completion.SortText.ObjectLiteralProperty(completion.SortText.LocationPriority, "M")),
             source: completion.CompletionSource.ObjectLiteralMethodSnippet,
             insertText: "M(x: number): void {\n},",
+            labelDetails: {
+                detail: "(x: number): void",
+            },
         },
     ],
 });
@@ -93,6 +97,7 @@ verify.completions({
         includeCompletionsWithInsertText: true,
         includeCompletionsWithSnippetText: false,
         includeCompletionsWithObjectLiteralMethodSnippets: true,
+        includeCompletionsWithLabelDetails: true,
     },
     includes: [
         {
@@ -106,6 +111,9 @@ verify.completions({
                 completion.SortText.ObjectLiteralProperty(completion.SortText.OptionalMember, "M")),
             source: completion.CompletionSource.ObjectLiteralMethodSnippet,
             insertText: "M(x: number): void {\n},",
+            labelDetails: {
+                detail: "(x: number): void",
+            },
         },
         {
             name: "N",
@@ -118,6 +126,9 @@ verify.completions({
                 completion.SortText.ObjectLiteralProperty(completion.SortText.LocationPriority, "N")),
             source: completion.CompletionSource.ObjectLiteralMethodSnippet,
             insertText: "N(x: string): void {\n},",
+            labelDetails: {
+                detail: "(x: string): void",
+            },
         },
         {
             name: "O",
@@ -130,6 +141,9 @@ verify.completions({
                 completion.SortText.ObjectLiteralProperty(completion.SortText.OptionalMember, "O")),
             source: completion.CompletionSource.ObjectLiteralMethodSnippet,
             insertText: "O(): void {\n},",
+            labelDetails: {
+                detail: "(): void",
+            },
         },
     ],
 });