Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork2.8k
fix(eslint-plugin): [consistent-indexed-object-style] don't report on indirect circular references#10537
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
JoshuaKGoldberg merged 8 commits intotypescript-eslint:mainfromronami:consistent-indexed-object-style-recursiveDec 30, 2024
Uh oh!
There was an error while loading.Please reload this page.
Merged
fix(eslint-plugin): [consistent-indexed-object-style] don't report on indirect circular references#10537
Changes fromall commits
Commits
Show all changes
8 commits Select commitHold shift + click to select a range
a0cdea1 initial implementation (squashed)
ronami43464cf revert unrelated changes
ronami474df6b remove now redundant eslint-disable comment
ronami59a8383 slight formatting change
ronami9bc7d99 remove unrelated changes
ronami185b38d add a test for missing coverage
ronami762fb84 add indirect union recursive test
ronamic81fe19 remove additional unnecessary comments
ronamiFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
104 changes: 94 additions & 10 deletionspackages/eslint-plugin/src/rules/consistent-indexed-object-style.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
| import type { ScopeVariable } from '@typescript-eslint/scope-manager'; | ||
| import type { TSESLint, TSESTree } from '@typescript-eslint/utils'; | ||
| import type { ReportFixFunction } from '@typescript-eslint/utils/ts-eslint'; | ||
| @@ -6,6 +7,7 @@ import { AST_NODE_TYPES, ASTUtils } from '@typescript-eslint/utils'; | ||
| import { | ||
| createRule, | ||
| getFixOrSuggest, | ||
| isNodeEqual, | ||
| isParenthesized, | ||
| nullThrows, | ||
| } from '../util'; | ||
| @@ -78,16 +80,12 @@ export default createRule<Options, MessageIds>({ | ||
| if (parentId) { | ||
| const scope = context.sourceCode.getScope(parentId); | ||
| const superVar = ASTUtils.findVariable(scope, parentId.name); | ||
| if ( | ||
| superVar && | ||
| isDeeplyReferencingType(node, superVar, new Set([parentId])) | ||
| ) { | ||
| return; | ||
| } | ||
| } | ||
| @@ -269,3 +267,89 @@ function findParentDeclaration( | ||
| } | ||
| return undefined; | ||
| } | ||
| function isDeeplyReferencingType( | ||
| node: TSESTree.Node, | ||
| superVar: ScopeVariable, | ||
| visited: Set<TSESTree.Node>, | ||
| ): boolean { | ||
| if (visited.has(node)) { | ||
| // something on the chain is circular but it's not the reference being checked | ||
| return false; | ||
| } | ||
| visited.add(node); | ||
| switch (node.type) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I went over the possibilities and I think I got them all, though it's possible I missed some 🙈 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. This is pretty thorough and for a not-very-common case. I'm never surprised by edge cases popping up in"check all kinds of nodes/types" logic, but would be surprised if many came out of this. | ||
| case AST_NODE_TYPES.TSTypeLiteral: | ||
| return node.members.some(member => | ||
| isDeeplyReferencingType(member, superVar, visited), | ||
| ); | ||
| case AST_NODE_TYPES.TSTypeAliasDeclaration: | ||
| return isDeeplyReferencingType(node.typeAnnotation, superVar, visited); | ||
| case AST_NODE_TYPES.TSIndexedAccessType: | ||
| return [node.indexType, node.objectType].some(type => | ||
| isDeeplyReferencingType(type, superVar, visited), | ||
| ); | ||
| case AST_NODE_TYPES.TSConditionalType: | ||
| return [ | ||
| node.checkType, | ||
| node.extendsType, | ||
| node.falseType, | ||
| node.trueType, | ||
| ].some(type => isDeeplyReferencingType(type, superVar, visited)); | ||
| case AST_NODE_TYPES.TSUnionType: | ||
| case AST_NODE_TYPES.TSIntersectionType: | ||
| return node.types.some(type => | ||
| isDeeplyReferencingType(type, superVar, visited), | ||
| ); | ||
| case AST_NODE_TYPES.TSInterfaceDeclaration: | ||
| return node.body.body.some(type => | ||
| isDeeplyReferencingType(type, superVar, visited), | ||
| ); | ||
| case AST_NODE_TYPES.TSTypeAnnotation: | ||
| return isDeeplyReferencingType(node.typeAnnotation, superVar, visited); | ||
| case AST_NODE_TYPES.TSIndexSignature: { | ||
| if (node.typeAnnotation) { | ||
| return isDeeplyReferencingType(node.typeAnnotation, superVar, visited); | ||
| } | ||
| break; | ||
| } | ||
| case AST_NODE_TYPES.TSTypeParameterInstantiation: { | ||
| return node.params.some(param => | ||
| isDeeplyReferencingType(param, superVar, visited), | ||
| ); | ||
| } | ||
| case AST_NODE_TYPES.TSTypeReference: { | ||
| if (isDeeplyReferencingType(node.typeName, superVar, visited)) { | ||
| return true; | ||
| } | ||
| if ( | ||
| node.typeArguments && | ||
| isDeeplyReferencingType(node.typeArguments, superVar, visited) | ||
| ) { | ||
| return true; | ||
| } | ||
| break; | ||
| } | ||
| case AST_NODE_TYPES.Identifier: { | ||
| // check if the identifier is a reference of the type being checked | ||
| if (superVar.references.some(ref => isNodeEqual(ref.identifier, node))) { | ||
| return true; | ||
| } | ||
| // otherwise, follow its definition(s) | ||
| const refVar = ASTUtils.findVariable(superVar.scope, node.name); | ||
| if (refVar) { | ||
| return refVar.defs.some(def => | ||
| isDeeplyReferencingType(def.node, superVar, visited), | ||
| ); | ||
| } | ||
| } | ||
| } | ||
| return false; | ||
| } | ||
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.