CR fixes

microsoft · Mar 30, 2022 · 41db01c · 41db01c
1 parent fe5a809
commit 41db01c
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 14 deletions.
diff --git a/src/compiler/types.ts b/src/compiler/types.ts
@@ -8753,7 +8753,7 @@ namespace ts {
         readonly includeCompletionsWithInsertText?: boolean;
         readonly includeCompletionsWithClassMemberSnippets?: boolean;
         readonly includeCompletionsWithObjectLiteralMethodSnippets?: boolean;
-        readonly includeCompletionsWithLabelDetails?: boolean;
+        readonly useLabelDetailsInCompletionEntries?: boolean;
         readonly allowIncompleteCompletions?: boolean;
         readonly importModuleSpecifierPreference?: "shortest" | "project-relative" | "relative" | "non-relative";
         /** Determines whether we import `foo/index.ts` as "foo", "foo/index", or "foo/index.js" */

diff --git a/src/server/protocol.ts b/src/server/protocol.ts
@@ -3434,8 +3434,9 @@ namespace ts.server.protocol {
         readonly includeCompletionsWithObjectLiteralMethodSnippets?: boolean;
         /**
          * Indicates whether {@link CompletionEntry.labelDetails completion entry label details} are supported.
+         * If not, contents of `labelDetails` may be included in the {@link CompletionEntry.name} property.
          */
-        readonly includeCompletionsWithLabelDetails?: boolean;
+        readonly useLabelDetailsInCompletionEntries?: boolean;
         readonly allowIncompleteCompletions?: boolean;
         readonly importModuleSpecifierPreference?: "shortest" | "project-relative" | "relative" | "non-relative";
         /** Determines whether we import `foo/index.ts` as "foo", "foo/index", or "foo/index.js" */

diff --git a/src/services/completions.ts b/src/services/completions.ts
@@ -782,7 +782,7 @@ namespace ts.Completions {
         if (origin && originIsObjectLiteralMethod(origin)) {
             let importAdder;
             ({ insertText, isSnippet, importAdder, labelDetails } = origin);
-            if (!preferences.includeCompletionsWithLabelDetails) {
+            if (!preferences.useLabelDetailsInCompletionEntries) {
                 name = name + labelDetails.detail;
                 labelDetails = undefined;
             }
@@ -1104,8 +1104,10 @@ namespace ts.Completions {
             target: options.target,
             omitTrailingSemicolon: true,
         });
+        // The `labelDetails.detail` will be displayed right beside the method name,
+        // so we drop the name (and modifiers) from the signature.
         const methodSignature = factory.createMethodSignature(
-            method.modifiers,
+            /*modifiers*/ undefined,
             /*name*/ "",
             method.questionToken,
             method.typeParameters,

diff --git a/tests/cases/fourslash/completionsObjectLiteralMethod1.ts b/tests/cases/fourslash/completionsObjectLiteralMethod1.ts
@@ -38,7 +38,7 @@ verify.completions({
         includeCompletionsWithInsertText: true,
         includeCompletionsWithSnippetText: false,
         includeCompletionsWithObjectLiteralMethodSnippets: true,
-        includeCompletionsWithLabelDetails: true,
+        useLabelDetailsInCompletionEntries: true,
     },
     includes: [
         {
@@ -64,7 +64,7 @@ verify.completions({
         includeCompletionsWithInsertText: true,
         includeCompletionsWithSnippetText: false,
         includeCompletionsWithObjectLiteralMethodSnippets: true,
-        includeCompletionsWithLabelDetails: true,
+        useLabelDetailsInCompletionEntries: true,
     },
     includes: [
         {
@@ -121,7 +121,7 @@ verify.completions({
         includeCompletionsWithInsertText: true,
         includeCompletionsWithSnippetText: false,
         includeCompletionsWithObjectLiteralMethodSnippets: true,
-        includeCompletionsWithLabelDetails: true,
+        useLabelDetailsInCompletionEntries: true,
     },
     includes: [
         {
@@ -147,7 +147,7 @@ verify.completions({
         includeCompletionsWithInsertText: true,
         includeCompletionsWithSnippetText: true,
         includeCompletionsWithObjectLiteralMethodSnippets: true,
-        includeCompletionsWithLabelDetails: true,
+        useLabelDetailsInCompletionEntries: true,
     },
     includes: [
         {
@@ -174,7 +174,7 @@ verify.completions({
         includeCompletionsWithInsertText: true,
         includeCompletionsWithSnippetText: true,
         includeCompletionsWithObjectLiteralMethodSnippets: true,
-        includeCompletionsWithLabelDetails: false,
+        useLabelDetailsInCompletionEntries: false,
     },
     includes: [
         {

diff --git a/tests/cases/fourslash/completionsObjectLiteralMethod2.ts b/tests/cases/fourslash/completionsObjectLiteralMethod2.ts
@@ -24,7 +24,7 @@ verify.completions({
         includeCompletionsWithInsertText: true,
         includeCompletionsWithSnippetText: false,
         includeCompletionsWithObjectLiteralMethodSnippets: true,
-        includeCompletionsWithLabelDetails: true,
+        useLabelDetailsInCompletionEntries: true,
     },
     includes: [
         {
@@ -51,7 +51,7 @@ verify.applyCodeActionFromCompletion("a", {
         includeCompletionsWithInsertText: true,
         includeCompletionsWithSnippetText: false,
         includeCompletionsWithObjectLiteralMethodSnippets: true,
-        includeCompletionsWithLabelDetails: true,
+        useLabelDetailsInCompletionEntries: true,
     },
     name: "foo",
     source: completion.CompletionSource.ObjectLiteralMethodSnippet,

diff --git a/tests/cases/fourslash/completionsObjectLiteralMethod3.ts b/tests/cases/fourslash/completionsObjectLiteralMethod3.ts
@@ -39,7 +39,7 @@ verify.completions({
         includeCompletionsWithInsertText: true,
         includeCompletionsWithSnippetText: false,
         includeCompletionsWithObjectLiteralMethodSnippets: true,
-        includeCompletionsWithLabelDetails: true,
+        useLabelDetailsInCompletionEntries: true,
     },
     includes: [
         {
@@ -97,7 +97,7 @@ verify.completions({
         includeCompletionsWithInsertText: true,
         includeCompletionsWithSnippetText: false,
         includeCompletionsWithObjectLiteralMethodSnippets: true,
-        includeCompletionsWithLabelDetails: true,
+        useLabelDetailsInCompletionEntries: true,
     },
     includes: [
         {

diff --git a/tests/cases/fourslash/fourslash.ts b/tests/cases/fourslash/fourslash.ts
@@ -648,7 +648,7 @@ declare namespace FourSlashInterface {
         readonly includeCompletionsWithInsertText?: boolean;
         readonly includeCompletionsWithClassMemberSnippets?: boolean;
         readonly includeCompletionsWithObjectLiteralMethodSnippets?: boolean;
-        readonly includeCompletionsWithLabelDetails?: boolean;
+        readonly useLabelDetailsInCompletionEntries?: boolean;
         readonly allowIncompleteCompletions?: boolean;
         /** @deprecated use `includeCompletionsWithInsertText` */
         readonly includeInsertTextCompletions?: boolean;