Skip to content

fix(eslint-plugin): [consistent-indexed-object-style] handle circular mapped types #10301

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 3 commits into from
Nov 14, 2024
Merged

fix(eslint-plugin): [consistent-indexed-object-style] handle circular mapped types #10301

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e0e68c2
fix(eslint-plugin): [consistent-indexed-object-style] handle circular…
JavaScriptBach Nov 7, 2024
9066e4b
Merge branch 'main' into cios-in
JavaScriptBach Nov 7, 2024
a66b769
Merge branch 'main' into cios-in
JavaScriptBach Nov 10, 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
18 changes: 18 additions & 0 deletions packages/eslint-plugin/src/rules/consistent-indexed-object-style.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,24 @@ export default createRule<Options, MessageIds>({
return;
}

// If the mapped type is circular, we can't convert it to a Record.
const parentId = findParentDeclaration(node)?.id;
if (parentId) {
const scope = context.sourceCode.getScope(key);
const superVar = ASTUtils.findVariable(scope, parentId.name);
if (superVar) {
const isCircular = superVar.references.some(
item =>
item.isTypeReference &&
node.range[0] <= item.identifier.range[0] &&
node.range[1] >= item.identifier.range[1],
);
if (isCircular) {
return;
}
}
}

// There's no builtin Mutable<T> type, so we can't autofix it really.
const canFix = node.readonly !== '-';

Expand Down
1 change: 1 addition & 0 deletions packages/eslint-plugin/tests/rules/consistent-indexed-object-style.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ interface Foo {
'type Foo = { [key: string]: string | Foo };',
'type Foo = { [key: string]: Foo };',
'type Foo = { [key: string]: Foo } | Foo;',
'type Foo = { [key in string]: Foo };',
`
interface Foo {
[key: string]: Foo;
Expand Down
Loading