Rename option

microsoft · jessetrinity · Jun 25, 2021 · Dec 23, 2020 · Dec 24, 2020 · Dec 24, 2020
commit d8dc8f193cd3dba4ebcab5bda03629c2ff54e937
diff --git a/src/compiler/types.ts b/src/compiler/types.ts
@@ -8479,9 +8479,8 @@ namespace ts {
         readonly providePrefixAndSuffixTextForRename?: boolean;
         readonly includePackageJsonAutoImports?: "auto" | "on" | "off";
         readonly provideRefactorNotApplicableReason?: boolean;
-        readonly includeInlayParameterNameHints?: boolean;
-        readonly includeInlayNonLiteralParameterNameHints?: boolean;
-        readonly includeInlayDuplicatedParameterNameHints?: boolean;
+        readonly includeInlayParameterNameHints?: "none" | "literals" | "all";
+        readonly includeInlayParameterNameHintsWhenArgumentMatchesName?: boolean;
         readonly includeInlayFunctionParameterTypeHints?: boolean;
         readonly includeInlayVariableTypeHints?: boolean;
         readonly includeInlayPropertyDeclarationTypeHints?: boolean;

diff --git a/src/services/inlayHints.ts b/src/services/inlayHints.ts
@@ -7,6 +7,14 @@ namespace ts.InlayHints {
         return new RegExp(`^\\s?/\\*\\*?\\s?${name}\\s?\\*\\/\\s?$`);
     };
 
+    function shouldShowParameterNameHints(preferences: UserPreferences) {
+        return preferences.includeInlayParameterNameHints === "literals" || preferences.includeInlayParameterNameHints === "all";
+    }
+
+    function shouldShowLiteralParameterNameHintsOnly(preferences: UserPreferences) {
+        return preferences.includeInlayParameterNameHints === "literals";
+    }
+
     export function provideInlayHints(context: InlayHintsContext): InlayHint[] {
         const { file, program, span, cancellationToken, preferences } = context;
         const sourceFileText = file.text;
@@ -52,7 +60,7 @@ namespace ts.InlayHints {
             else if (preferences.includeInlayEnumMemberValueHints && isEnumMember(node)) {
                 visitEnumMember(node);
             }
-            else if (preferences.includeInlayParameterNameHints && (isCallExpression(node) || isNewExpression(node))) {
+            else if (shouldShowParameterNameHints(preferences) && (isCallExpression(node) || isNewExpression(node))) {
                 visitCallOrNewExpression(node);
             }
             else {
@@ -147,14 +155,14 @@ namespace ts.InlayHints {
 
             for (let i = 0; i < args.length; ++i) {
                 const arg = args[i];
-                if (!preferences.includeInlayNonLiteralParameterNameHints && !isHintableExpression(arg)) {
+                if (shouldShowLiteralParameterNameHintsOnly(preferences) && !isHintableExpression(arg)) {
                     continue;
                 }
 
                 const identifierNameInfo = checker.getParameterIdentifierNameAtPosition(signature, i);
                 if (identifierNameInfo) {
                     const [parameterName, isFirstVariadicArgument] = identifierNameInfo;
-                    const isParameterNameNotSameAsArgument = preferences.includeInlayDuplicatedParameterNameHints || !isIdentifier(arg) || arg.text !== parameterName;
+                    const isParameterNameNotSameAsArgument = preferences.includeInlayParameterNameHintsWhenArgumentMatchesName || !isIdentifier(arg) || arg.text !== parameterName;
                     if (!isParameterNameNotSameAsArgument && !isFirstVariadicArgument) {
                         continue;
                     }

diff --git a/src/services/types.ts b/src/services/types.ts
@@ -573,9 +573,8 @@ namespace ts {
     }
 
     export interface InlayHintsOptions extends UserPreferences {
-        readonly includeInlayParameterNameHints?: boolean;
-        readonly includeInlayNonLiteralParameterNameHints?: boolean;
-        readonly includeInlayDuplicatedParameterNameHints?: boolean;
+        readonly includeInlayParameterNameHints?: "none" | "literals" | "all";
+        readonly includeInlayParameterNameHintsWhenArgumentMatchesName?: boolean;
         readonly includeInlayFunctionParameterTypeHints?: boolean,
         readonly includeInlayVariableTypeHints?: boolean;
         readonly includeInlayPropertyDeclarationTypeHints?: boolean;

diff --git a/tests/baselines/reference/api/tsserverlibrary.d.ts b/tests/baselines/reference/api/tsserverlibrary.d.ts
@@ -3957,9 +3957,8 @@ declare namespace ts {
         readonly providePrefixAndSuffixTextForRename?: boolean;
         readonly includePackageJsonAutoImports?: "auto" | "on" | "off";
         readonly provideRefactorNotApplicableReason?: boolean;
-        readonly includeInlayParameterNameHints?: boolean;
-        readonly includeInlayNonLiteralParameterNameHints?: boolean;
-        readonly includeInlayDuplicatedParameterNameHints?: boolean;
+        readonly includeInlayParameterNameHints?: "none" | "literals" | "all";
+        readonly includeInlayParameterNameHintsWhenArgumentMatchesName?: boolean;
         readonly includeInlayFunctionParameterTypeHints?: boolean;
         readonly includeInlayVariableTypeHints?: boolean;
         readonly includeInlayPropertyDeclarationTypeHints?: boolean;
@@ -5746,9 +5745,8 @@ declare namespace ts {
         includeInsertTextCompletions?: boolean;
     }
     interface InlayHintsOptions extends UserPreferences {
-        readonly includeInlayParameterNameHints?: boolean;
-        readonly includeInlayNonLiteralParameterNameHints?: boolean;
-        readonly includeInlayDuplicatedParameterNameHints?: boolean;
+        readonly includeInlayParameterNameHints?: "none" | "literals" | "all";
+        readonly includeInlayParameterNameHintsWhenArgumentMatchesName?: boolean;
         readonly includeInlayFunctionParameterTypeHints?: boolean;
         readonly includeInlayVariableTypeHints?: boolean;
         readonly includeInlayPropertyDeclarationTypeHints?: boolean;

diff --git a/tests/baselines/reference/api/typescript.d.ts b/tests/baselines/reference/api/typescript.d.ts
@@ -3957,9 +3957,8 @@ declare namespace ts {
         readonly providePrefixAndSuffixTextForRename?: boolean;
         readonly includePackageJsonAutoImports?: "auto" | "on" | "off";
         readonly provideRefactorNotApplicableReason?: boolean;
-        readonly includeInlayParameterNameHints?: boolean;
-        readonly includeInlayNonLiteralParameterNameHints?: boolean;
-        readonly includeInlayDuplicatedParameterNameHints?: boolean;
+        readonly includeInlayParameterNameHints?: "none" | "literals" | "all";
+        readonly includeInlayParameterNameHintsWhenArgumentMatchesName?: boolean;
         readonly includeInlayFunctionParameterTypeHints?: boolean;
         readonly includeInlayVariableTypeHints?: boolean;
         readonly includeInlayPropertyDeclarationTypeHints?: boolean;
@@ -5746,9 +5745,8 @@ declare namespace ts {
         includeInsertTextCompletions?: boolean;
     }
     interface InlayHintsOptions extends UserPreferences {
-        readonly includeInlayParameterNameHints?: boolean;
-        readonly includeInlayNonLiteralParameterNameHints?: boolean;
-        readonly includeInlayDuplicatedParameterNameHints?: boolean;
+        readonly includeInlayParameterNameHints?: "none" | "literals" | "all";
+        readonly includeInlayParameterNameHintsWhenArgumentMatchesName?: boolean;
         readonly includeInlayFunctionParameterTypeHints?: boolean;
         readonly includeInlayVariableTypeHints?: boolean;
         readonly includeInlayPropertyDeclarationTypeHints?: boolean;

diff --git a/tests/cases/fourslash/fourslash.ts b/tests/cases/fourslash/fourslash.ts
@@ -644,9 +644,8 @@ declare namespace FourSlashInterface {
         readonly importModuleSpecifierEnding?: "minimal" | "index" | "js";
     }
     interface InlayHintsOptions extends UserPreferences {
-        readonly includeInlayParameterNameHints?: boolean;
-        readonly includeInlayNonLiteralParameterNameHints?: boolean;
-        readonly includeInlayDuplicatedParameterNameHints?: boolean;
+        readonly includeInlayParameterNameHints?: "none" | "literals" | "all";
+        readonly includeInlayParameterNameHintsWhenArgumentMatchesName?: boolean;
         readonly includeInlayFunctionParameterTypeHints?: boolean;
         readonly includeInlayVariableTypeHints?: boolean;
         readonly includeInlayPropertyDeclarationTypeHints?: boolean;

diff --git a/tests/cases/fourslash/inlayHintsShouldWork1.ts b/tests/cases/fourslash/inlayHintsShouldWork1.ts
@@ -18,5 +18,5 @@ verify.getInlayHints([
         whitespaceAfter: true
     }
 ], undefined, {
-    includeInlayParameterNameHints: true
+    includeInlayParameterNameHints: "literals"
 });
diff --git a/tests/cases/fourslash/inlayHintsShouldWork10.ts b/tests/cases/fourslash/inlayHintsShouldWork10.ts
@@ -5,5 +5,5 @@
 
 const markers = test.markers();
 verify.getInlayHints([], undefined, {
-    includeInlayParameterNameHints: true
+    includeInlayParameterNameHints: "literals"
 });
diff --git a/tests/cases/fourslash/inlayHintsShouldWork11.ts b/tests/cases/fourslash/inlayHintsShouldWork11.ts
@@ -22,5 +22,5 @@ verify.getInlayHints([
         whitespaceAfter: true
     },
 ], undefined, {
-    includeInlayParameterNameHints: true
+    includeInlayParameterNameHints: "literals"
 });
diff --git a/tests/cases/fourslash/inlayHintsShouldWork12.ts b/tests/cases/fourslash/inlayHintsShouldWork12.ts
@@ -21,5 +21,5 @@ verify.getInlayHints([
         whitespaceAfter: true
     },
 ], undefined, {
-    includeInlayParameterNameHints: true
+    includeInlayParameterNameHints: "literals"
 });
diff --git a/tests/cases/fourslash/inlayHintsShouldWork13.ts b/tests/cases/fourslash/inlayHintsShouldWork13.ts
@@ -13,7 +13,6 @@ verify.getInlayHints([
         whitespaceAfter: true
     },
 ], undefined, {
-    includeInlayParameterNameHints: true,
-    includeInlayNonLiteralParameterNameHints: true,
-    includeInlayDuplicatedParameterNameHints: false,
+    includeInlayParameterNameHints: "all",
+    includeInlayParameterNameHintsWhenArgumentMatchesName: false,
 });
diff --git a/tests/cases/fourslash/inlayHintsShouldWork14.ts b/tests/cases/fourslash/inlayHintsShouldWork14.ts
@@ -4,5 +4,5 @@
 //// foo(1, 2);
 
 verify.getInlayHints([], undefined, {
-    includeInlayParameterNameHints: false
+    includeInlayParameterNameHints: "none"
 });
diff --git a/tests/cases/fourslash/inlayHintsShouldWork2.ts b/tests/cases/fourslash/inlayHintsShouldWork2.ts
@@ -12,5 +12,5 @@ verify.getInlayHints([
         whitespaceAfter: true
     }
 ], undefined, {
-    includeInlayParameterNameHints: true
+    includeInlayParameterNameHints: "literals"
 });
diff --git a/tests/cases/fourslash/inlayHintsShouldWork23.ts b/tests/cases/fourslash/inlayHintsShouldWork23.ts
@@ -12,5 +12,5 @@ verify.getInlayHints([
         whitespaceAfter: true
     }
 ], undefined, {
-    includeInlayParameterNameHints: true
+    includeInlayParameterNameHints: "literals"
 });
diff --git a/tests/cases/fourslash/inlayHintsShouldWork29.ts b/tests/cases/fourslash/inlayHintsShouldWork29.ts
@@ -32,6 +32,6 @@ verify.getInlayHints([
         whitespaceBefore: true
     }
 ], undefined, {
-    includeInlayParameterNameHints: true,
+    includeInlayParameterNameHints: "literals",
     includeInlayFunctionParameterTypeHints: true
 });
diff --git a/tests/cases/fourslash/inlayHintsShouldWork3.ts b/tests/cases/fourslash/inlayHintsShouldWork3.ts
@@ -18,5 +18,5 @@ verify.getInlayHints([
         whitespaceAfter: true
     }
 ], undefined, {
-    includeInlayParameterNameHints: true
+    includeInlayParameterNameHints: "literals"
 });
diff --git a/tests/cases/fourslash/inlayHintsShouldWork32.ts b/tests/cases/fourslash/inlayHintsShouldWork32.ts
@@ -27,5 +27,5 @@ verify.getInlayHints(
             whitespaceAfter: true
         }
     }), span, {
-    includeInlayParameterNameHints: true
+    includeInlayParameterNameHints: "literals"
 })
diff --git a/tests/cases/fourslash/inlayHintsShouldWork33.ts b/tests/cases/fourslash/inlayHintsShouldWork33.ts
@@ -27,5 +27,5 @@ verify.getInlayHints(
             whitespaceAfter: true
         }
     }), span, {
-    includeInlayParameterNameHints: true
+    includeInlayParameterNameHints: "literals"
 });
diff --git a/tests/cases/fourslash/inlayHintsShouldWork34.ts b/tests/cases/fourslash/inlayHintsShouldWork34.ts
@@ -25,6 +25,5 @@ verify.getInlayHints(
         kind: ts.InlayHintKind.Parameter,
         whitespaceAfter: true
     })) , undefined, {
-    includeInlayParameterNameHints: true,
-    includeInlayNonLiteralParameterNameHints: false
+    includeInlayParameterNameHints: "literals"
 });
diff --git a/tests/cases/fourslash/inlayHintsShouldWork35.ts b/tests/cases/fourslash/inlayHintsShouldWork35.ts
@@ -25,6 +25,5 @@ verify.getInlayHints(
         kind: ts.InlayHintKind.Parameter,
         whitespaceAfter: true
     })) , undefined, {
-    includeInlayParameterNameHints: true,
-    includeInlayNonLiteralParameterNameHints: true
+    includeInlayParameterNameHints: "all"
 });
diff --git a/tests/cases/fourslash/inlayHintsShouldWork36.ts b/tests/cases/fourslash/inlayHintsShouldWork36.ts
@@ -19,7 +19,6 @@ verify.getInlayHints([
         whitespaceAfter: true
     },
 ], undefined, {
-    includeInlayParameterNameHints: true,
-    includeInlayNonLiteralParameterNameHints: true,
-    includeInlayDuplicatedParameterNameHints: true,
+    includeInlayParameterNameHints: "all",
+    includeInlayParameterNameHintsWhenArgumentMatchesName: true,
 });
diff --git a/tests/cases/fourslash/inlayHintsShouldWork4.ts b/tests/cases/fourslash/inlayHintsShouldWork4.ts
@@ -28,5 +28,5 @@ verify.getInlayHints([
         whitespaceAfter: true
     }
 ], undefined, {
-    includeInlayParameterNameHints: true
+    includeInlayParameterNameHints: "literals"
 });
diff --git a/tests/cases/fourslash/inlayHintsShouldWork47.ts b/tests/cases/fourslash/inlayHintsShouldWork47.ts
@@ -29,5 +29,5 @@ verify.getInlayHints([
         whitespaceAfter: true
     }
 ], undefined, {
-    includeInlayParameterNameHints: true
+    includeInlayParameterNameHints: "literals"
 });
diff --git a/tests/cases/fourslash/inlayHintsShouldWork49.ts b/tests/cases/fourslash/inlayHintsShouldWork49.ts
@@ -13,5 +13,5 @@
 goTo.file('/a.js')
 const markers = test.markers();
 verify.getInlayHints([], undefined, {
-    includeInlayParameterNameHints: true
+    includeInlayParameterNameHints: "literals"
 });
diff --git a/tests/cases/fourslash/inlayHintsShouldWork5.ts b/tests/cases/fourslash/inlayHintsShouldWork5.ts
@@ -25,5 +25,5 @@ verify.getInlayHints([
         whitespaceAfter: true
     }
 ], undefined, {
-    includeInlayParameterNameHints: true
+    includeInlayParameterNameHints: "literals"
 });
diff --git a/tests/cases/fourslash/inlayHintsShouldWork50.ts b/tests/cases/fourslash/inlayHintsShouldWork50.ts
@@ -45,5 +45,5 @@ verify.getInlayHints([
         whitespaceAfter: true
     },
 ], undefined, {
-    includeInlayParameterNameHints: true
+    includeInlayParameterNameHints: "literals"
 });
diff --git a/tests/cases/fourslash/inlayHintsShouldWork52.ts b/tests/cases/fourslash/inlayHintsShouldWork52.ts
@@ -73,6 +73,6 @@ verify.getInlayHints([
         whitespaceAfter: true
     }
 ], undefined, {
-    includeInlayParameterNameHints: true,
+    includeInlayParameterNameHints: "literals",
     includeInlayFunctionLikeReturnTypeHints: true
 });
diff --git a/tests/cases/fourslash/inlayHintsShouldWork53.ts b/tests/cases/fourslash/inlayHintsShouldWork53.ts
@@ -12,5 +12,5 @@ verify.getInlayHints([
         whitespaceAfter: true
     }
 ], undefined, {
-    includeInlayParameterNameHints: true
+    includeInlayParameterNameHints: "literals"
 });
diff --git a/tests/cases/fourslash/inlayHintsShouldWork6.ts b/tests/cases/fourslash/inlayHintsShouldWork6.ts
@@ -13,5 +13,5 @@ verify.getInlayHints([
         whitespaceAfter: true
     }
 ], undefined, {
-    includeInlayParameterNameHints: true
+    includeInlayParameterNameHints: "literals"
 });
diff --git a/tests/cases/fourslash/inlayHintsShouldWork7.ts b/tests/cases/fourslash/inlayHintsShouldWork7.ts
@@ -29,5 +29,5 @@ verify.getInlayHints([
         whitespaceAfter: true
     }
 ], undefined, {
-    includeInlayParameterNameHints: true
+    includeInlayParameterNameHints: "literals"
 });
diff --git a/tests/cases/fourslash/inlayHintsShouldWork8.ts b/tests/cases/fourslash/inlayHintsShouldWork8.ts
@@ -29,5 +29,5 @@ verify.getInlayHints([
         whitespaceAfter: true
     }
 ], undefined, {
-    includeInlayParameterNameHints: true
+    includeInlayParameterNameHints: "literals"
 });
diff --git a/tests/cases/fourslash/inlayHintsShouldWork9.ts b/tests/cases/fourslash/inlayHintsShouldWork9.ts
@@ -37,5 +37,5 @@ verify.getInlayHints([
         whitespaceAfter: true
     }
 ], undefined, {
-    includeInlayParameterNameHints: true
+    includeInlayParameterNameHints: "literals"
 });