Skip to content

fix(eslint-plugin): [no-base-to-string] check array generic type #10437

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 10 commits into from
Dec 30, 2024
Merged

fix(eslint-plugin): [no-base-to-string] check array generic type #10437

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
1052e4c
initial implementation
ronami Dec 1, 2024
93a83e2
add missing test
ronami Dec 1, 2024
a13cfcf
undo unrelated change
ronami Dec 1, 2024
9ed7c53
also cover [].toString()
ronami Dec 1, 2024
2b85f4d
refactor
ronami Dec 2, 2024
d2e2917
Merge remote-tracking branch 'origin/main' into no-base-to-string-che…
ronami Dec 7, 2024
07c59ca
respect the ignoredTypeNames option
ronami Dec 15, 2024
0bc1024
update existing tests to use a helper for checking arrays, and change…
ronami Dec 18, 2024
2fc6c6c
don't use a test helper for creating tests dynamically
ronami Dec 26, 2024
5ebba43
remove unnecessary check
ronami Dec 30, 2024
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
52 changes: 34 additions & 18 deletions packages/eslint-plugin/src/rules/no-base-to-string.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ enum Usefulness {
Sometimes = 'may',
}

type Options = [
export type Options = [
{
ignoredTypeNames?: string[];
},
];
type MessageIds = 'baseArrayJoin' | 'baseToString';
export type MessageIds = 'baseArrayJoin' | 'baseToString';

export default createRule<Options, MessageIds>({
name: 'no-base-to-string',
Expand Down Expand Up @@ -140,6 +140,28 @@ export default createRule<Options, MessageIds>({
return Usefulness.Never;
}

function collectTupleCertainty(type: ts.TypeReference): Usefulness {
const typeArgs = checker.getTypeArguments(type);
const certainties = typeArgs.map(t => collectToStringCertainty(t));
if (certainties.some(certainty => certainty === Usefulness.Never)) {
return Usefulness.Never;
}

if (certainties.some(certainty => certainty === Usefulness.Sometimes)) {
return Usefulness.Sometimes;
}

return Usefulness.Always;
}

function collectArrayCertainty(type: ts.Type): Usefulness {
const elemType = nullThrows(
type.getNumberIndexType(),
'array should have number index type',
);
return collectToStringCertainty(elemType);
}

function collectJoinCertainty(type: ts.Type): Usefulness {
if (tsutils.isUnionType(type)) {
return collectUnionTypeCertainty(type, collectJoinCertainty);
Expand All @@ -150,25 +172,11 @@ export default createRule<Options, MessageIds>({
}

if (checker.isTupleType(type)) {
const typeArgs = checker.getTypeArguments(type);
const certainties = typeArgs.map(t => collectToStringCertainty(t));
if (certainties.some(certainty => certainty === Usefulness.Never)) {
return Usefulness.Never;
}

if (certainties.some(certainty => certainty === Usefulness.Sometimes)) {
return Usefulness.Sometimes;
}

return Usefulness.Always;
return collectTupleCertainty(type);
}

if (checker.isArrayType(type)) {
const elemType = nullThrows(
type.getNumberIndexType(),
'array should have number index type',
);
return collectToStringCertainty(elemType);
return collectArrayCertainty(type);
}

return Usefulness.Always;
Expand Down Expand Up @@ -205,6 +213,14 @@ export default createRule<Options, MessageIds>({
return collectUnionTypeCertainty(type, collectToStringCertainty);
}

if (checker.isTupleType(type)) {
return collectTupleCertainty(type);
}

if (checker.isArrayType(type)) {
return collectArrayCertainty(type);
}

const toString =
checker.getPropertyOfType(type, 'toString') ??
checker.getPropertyOfType(type, 'toLocaleString');
Expand Down
Loading
Loading