Skip to content
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

Jump to bottom

feat(45295): Consider adding setting that only shows inlay hint parameter names for simple literals (string, number, bool) #45457

Closed
wants to merge 1 commit into from
Closed

feat(45295): Consider adding setting that only shows inlay hint parameter names for simple literals (string, number, bool) #45457

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
58 changes: 33 additions & 25 deletions src/services/inlayHints.ts
View file
Open in desktop
Expand Up @@ -8,11 +8,7 @@ namespace ts.InlayHints {
};

function shouldShowParameterNameHints(preferences: InlayHintsOptions) {
return preferences.includeInlayParameterNameHints === "literals" || preferences.includeInlayParameterNameHints === "all";
}

function shouldShowLiteralParameterNameHintsOnly(preferences: InlayHintsOptions) {
return preferences.includeInlayParameterNameHints === "literals";
return !!preferences.includeInlayParameterNameHints && preferences.includeInlayParameterNameHints !== "none";
}

export function provideInlayHints(context: InlayHintsContext): InlayHint[] {
Expand Down Expand Up @@ -156,9 +152,9 @@ namespace ts.InlayHints {
for (let i = 0; i < args.length; ++i) {
const originalArg = args[i];
const arg = skipParentheses(originalArg);
if (shouldShowLiteralParameterNameHintsOnly(preferences) && !isHintableExpression(arg)) {
continue;
}

if ((preferences.includeInlayParameterNameHints === "literals" && !isLiteralLike(arg)) ||
(preferences.includeInlayParameterNameHints === "primitiveLiterals" && !isPrimitiveLiteral(arg))) continue;

const identifierNameInfo = checker.getParameterIdentifierNameAtPosition(signature, i);
if (identifierNameInfo) {
Expand Down Expand Up @@ -202,28 +198,40 @@ namespace ts.InlayHints {
return some(ranges, range => regex.test(sourceFileText.substring(range.pos, range.end)));
}

function isHintableExpression(node: Node) {
function isLiteralLike(node: Node): boolean {
switch (node.kind) {
case SyntaxKind.PrefixUnaryExpression: {
const operand = (node as PrefixUnaryExpression).operand;
return isLiteralExpression(operand) || isIdentifier(operand) && isInfinityOrNaNString(operand.escapedText);
}
case SyntaxKind.TrueKeyword:
case SyntaxKind.FalseKeyword:
case SyntaxKind.ArrayLiteralExpression:
case SyntaxKind.ObjectLiteralExpression:
case SyntaxKind.FunctionExpression:
case SyntaxKind.ArrowFunction:
case SyntaxKind.ObjectLiteralExpression:
case SyntaxKind.ArrayLiteralExpression:
case SyntaxKind.NullKeyword:
case SyntaxKind.RegularExpressionLiteral:
case SyntaxKind.NoSubstitutionTemplateLiteral:
case SyntaxKind.TemplateExpression:
return true;
case SyntaxKind.Identifier: {
const name = (node as Identifier).escapedText;
return isUndefined(name) || isInfinityOrNaNString(name);
}
case SyntaxKind.PrefixUnaryExpression:
return isLiteralLike(skipParentheses((node as PrefixUnaryExpression).operand));
default:
return isPrimitiveLiteral(node);
}
}

function isPrimitiveLiteral(node: Node): boolean {
switch (node.kind) {
case SyntaxKind.TrueKeyword:
case SyntaxKind.FalseKeyword:
case SyntaxKind.NullKeyword:
case SyntaxKind.StringLiteral:
case SyntaxKind.NumericLiteral:
case SyntaxKind.BigIntLiteral:
return true;
case SyntaxKind.Identifier:
return isUndefined(node) || isInfinityOrNaNString((node as Identifier).escapedText);
case SyntaxKind.PrefixUnaryExpression:
const operand = skipParentheses((node as PrefixUnaryExpression).operand);
return !(operand.kind === SyntaxKind.NullKeyword || operand.kind === SyntaxKind.BigIntLiteral || isUndefined(operand)) && isPrimitiveLiteral(operand);
default:
return false;
}
return isLiteralExpression(node);
}

function visitFunctionDeclarationLikeForReturnType(decl: FunctionDeclaration | ArrowFunction | FunctionExpression | MethodDeclaration | GetAccessorDeclaration) {
Expand Down Expand Up @@ -320,8 +328,8 @@ namespace ts.InlayHints {
});
}

function isUndefined(name: __String) {
return name === "undefined";
function isUndefined(node: Node) {
return isIdentifier(node) && node.escapedText === "undefined";
}
}
}
2 changes: 1 addition & 1 deletion src/services/types.ts
View file
Open in desktop
Expand Up @@ -579,7 +579,7 @@ namespace ts {
}

export interface InlayHintsOptions extends UserPreferences {
readonly includeInlayParameterNameHints?: "none" | "literals" | "all";
readonly includeInlayParameterNameHints?: "none" | "literals" | "primitiveLiterals" | "all";
readonly includeInlayParameterNameHintsWhenArgumentMatchesName?: boolean;
readonly includeInlayFunctionParameterTypeHints?: boolean,
readonly includeInlayVariableTypeHints?: boolean;
Expand Down
2 changes: 1 addition & 1 deletion tests/baselines/reference/api/tsserverlibrary.d.ts
View file
Open in desktop
Expand Up @@ -5766,7 +5766,7 @@ declare namespace ts {
includeInsertTextCompletions?: boolean;
}
interface InlayHintsOptions extends UserPreferences {
readonly includeInlayParameterNameHints?: "none" | "literals" | "all";
readonly includeInlayParameterNameHints?: "none" | "literals" | "primitiveLiterals" | "all";
readonly includeInlayParameterNameHintsWhenArgumentMatchesName?: boolean;
readonly includeInlayFunctionParameterTypeHints?: boolean;
readonly includeInlayVariableTypeHints?: boolean;
Expand Down
2 changes: 1 addition & 1 deletion tests/baselines/reference/api/typescript.d.ts
View file
Open in desktop
Expand Up @@ -5766,7 +5766,7 @@ declare namespace ts {
includeInsertTextCompletions?: boolean;
}
interface InlayHintsOptions extends UserPreferences {
readonly includeInlayParameterNameHints?: "none" | "literals" | "all";
readonly includeInlayParameterNameHints?: "none" | "literals" | "primitiveLiterals" | "all";
readonly includeInlayParameterNameHintsWhenArgumentMatchesName?: boolean;
readonly includeInlayFunctionParameterTypeHints?: boolean;
readonly includeInlayVariableTypeHints?: boolean;
Expand Down
2 changes: 1 addition & 1 deletion tests/cases/fourslash/fourslash.ts
View file
Open in desktop
Expand Up @@ -645,7 +645,7 @@ declare namespace FourSlashInterface {
readonly importModuleSpecifierEnding?: "minimal" | "index" | "js";
}
interface InlayHintsOptions extends UserPreferences {
readonly includeInlayParameterNameHints?: "none" | "literals" | "all";
readonly includeInlayParameterNameHints?: "none" | "literals" | "primitiveLiterals" | "all";
readonly includeInlayParameterNameHintsWhenArgumentMatchesName?: boolean;
readonly includeInlayFunctionParameterTypeHints?: boolean;
readonly includeInlayVariableTypeHints?: boolean;
Expand Down
85 changes: 85 additions & 0 deletions tests/cases/fourslash/inlayHintsShouldWork65.ts
View file
Open in desktop
@@ -0,0 +1,85 @@
/// <reference path="fourslash.ts" />

////function foo(
//// a: number,
//// b: number,
//// c: number,
//// d: number,
//// e: number,
//// f: number,
//// g: number,
//// h: number,
//// i: number
////) {}
////
////foo(
//// /*a*/+"",
//// /*b*/+``,
//// /*c*/+{},
//// /*d*/+[],
//// /*e*/+/a/,
//// /*f*/+Infinity,
//// /*g*/+NaN,
//// /*h*/+function() {},
//// /*i*/+(() => {}),
////);

const [a, b, c, d, e, f, g, h, i] = test.markers();
verify.getInlayHints([
{
text: "a:",
position: a.position,
kind: ts.InlayHintKind.Parameter,
whitespaceAfter: true
},
{
text: "b:",
position: b.position,
kind: ts.InlayHintKind.Parameter,
whitespaceAfter: true
},
{
text: "c:",
position: c.position,
kind: ts.InlayHintKind.Parameter,
whitespaceAfter: true
},
{
text: "d:",
position: d.position,
kind: ts.InlayHintKind.Parameter,
whitespaceAfter: true
},
{
text: "e:",
position: e.position,
kind: ts.InlayHintKind.Parameter,
whitespaceAfter: true
},
{
text: "f:",
position: f.position,
kind: ts.InlayHintKind.Parameter,
whitespaceAfter: true
},
{
text: "g:",
position: g.position,
kind: ts.InlayHintKind.Parameter,
whitespaceAfter: true
},
{
text: "h:",
position: h.position,
kind: ts.InlayHintKind.Parameter,
whitespaceAfter: true
},
{
text: "i:",
position: i.position,
kind: ts.InlayHintKind.Parameter,
whitespaceAfter: true
}
], undefined, {
includeInlayParameterNameHints: "literals"
});
86 changes: 86 additions & 0 deletions tests/cases/fourslash/inlayHints_primitiveLiterals1.ts
View file
Open in desktop
@@ -0,0 +1,86 @@
/// <reference path="fourslash.ts" />

////function foo(
//// a: string,
//// b: undefined,
//// c: null,
//// d: boolean,
//// e: boolean,
//// f: number,
//// g: number,
//// h: number,
//// i: bigint
////) {
////}
////
////foo(
//// /*a*/"hello",
//// /*b*/undefined,
//// /*c*/null,
//// /*d*/true,
//// /*e*/false,
//// /*f*/Infinity,
//// /*g*/-Infinity,
//// /*h*/NaN,
//// /*i*/123n
////);

const [a, b, c, d, e, f, g, h, i] = test.markers();
verify.getInlayHints([
{
text: "a:",
position: a.position,
kind: ts.InlayHintKind.Parameter,
whitespaceAfter: true
},
{
text: "b:",
position: b.position,
kind: ts.InlayHintKind.Parameter,
whitespaceAfter: true
},
{
text: "c:",
position: c.position,
kind: ts.InlayHintKind.Parameter,
whitespaceAfter: true
},
{
text: "d:",
position: d.position,
kind: ts.InlayHintKind.Parameter,
whitespaceAfter: true
},
{
text: "e:",
position: e.position,
kind: ts.InlayHintKind.Parameter,
whitespaceAfter: true
},
{
text: "f:",
position: f.position,
kind: ts.InlayHintKind.Parameter,
whitespaceAfter: true
},
{
text: "g:",
position: g.position,
kind: ts.InlayHintKind.Parameter,
whitespaceAfter: true
},
{
text: "h:",
position: h.position,
kind: ts.InlayHintKind.Parameter,
whitespaceAfter: true
},
{
text: "i:",
position: i.position,
kind: ts.InlayHintKind.Parameter,
whitespaceAfter: true
}
], undefined, {
includeInlayParameterNameHints: "primitiveLiterals"
});
25 changes: 25 additions & 0 deletions tests/cases/fourslash/inlayHints_primitiveLiterals2.ts
View file
Open in desktop
@@ -0,0 +1,25 @@
/// <reference path="fourslash.ts" />

////function foo(
//// a: number[],
//// b: { x: number; y: number; },
//// c: () => void,
//// d: () => void,
//// e: RegExp,
//// f: string,
//// g: string
////) {}
////
////foo(
//// /*a*/[1],
//// /*b*/{ x: 1, y: 1 },
//// /*c*/() => {},
//// /*d*/function () {},
//// /*e*//foo/i,
//// /*f*/``
//// /*g*/`${1} ${2} ${3}`
////);

verify.getInlayHints([], undefined, {
includeInlayParameterNameHints: "primitiveLiterals"
});