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): [no-for-in-array] report on any type which may be an array or array-like#10535
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 10 commits intotypescript-eslint:mainfromronami:no-for-in-array-nullishJan 19, 2025
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
10 commits Select commitHold shift + click to select a range
75d1ecb report on for-in on 'Array<T> | undefined'
ronami4ded1c5 update the rule to report on anything that may be an array or array-like
ronami7efca69 nested test cases
ronamie126dab refactor code to use 'isBuiltinSymbolLike' for checking the arguments…
ronamib612eef refactor, add some more array-likes
ronami6466fb5 undo unrelated change
ronami2ce3cea use lib-dom tsconfig only for tests that need it
ronami006eb4c Merge branch 'main' into no-for-in-array-nullish
ronami762934d fix failing tests
ronami599ac75 check array-like based on it having a length and a number-index-signa…
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
38 changes: 33 additions & 5 deletionspackages/eslint-plugin/src/rules/no-for-in-array.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,10 +1,10 @@ | ||
| import * as tsutils from 'ts-api-utils'; | ||
| import * as ts from 'typescript'; | ||
| import { | ||
| createRule, | ||
| getConstrainedTypeAtLocation, | ||
| getParserServices, | ||
| } from '../util'; | ||
| import { getForStatementHeadLoc } from '../util/getForStatementHeadLoc'; | ||
| @@ -32,10 +32,7 @@ export default createRule({ | ||
| const type = getConstrainedTypeAtLocation(services, node.right); | ||
kirkwaiblinger marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| if (isArrayLike(checker, type)) { | ||
| context.report({ | ||
| loc: getForStatementHeadLoc(context.sourceCode, node), | ||
| messageId: 'forInViolation', | ||
| @@ -45,3 +42,34 @@ export default createRule({ | ||
| }; | ||
| }, | ||
| }); | ||
| function isArrayLike(checker: ts.TypeChecker, type: ts.Type): boolean { | ||
| return isTypeRecurser( | ||
| type, | ||
| t => t.getNumberIndexType() != null && hasArrayishLength(checker, t), | ||
| ); | ||
| } | ||
| function hasArrayishLength(checker: ts.TypeChecker, type: ts.Type): boolean { | ||
| const lengthProperty = type.getProperty('length'); | ||
| if (lengthProperty == null) { | ||
| return false; | ||
| } | ||
| return tsutils.isTypeFlagSet( | ||
| checker.getTypeOfSymbol(lengthProperty), | ||
| ts.TypeFlags.NumberLike, | ||
| ); | ||
| } | ||
| function isTypeRecurser( | ||
| type: ts.Type, | ||
| predicate: (t: ts.Type) => boolean, | ||
| ): boolean { | ||
| if (type.isUnionOrIntersection()) { | ||
| return type.types.some(t => isTypeRecurser(t, predicate)); | ||
| } | ||
| return predicate(type); | ||
| } | ||
6 changes: 6 additions & 0 deletionspackages/eslint-plugin/tests/fixtures/tsconfig.lib-dom.json
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 |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "extends": "./tsconfig.json", | ||
| "compilerOptions": { | ||
| "lib": ["es2015", "es2017", "esnext", "dom"] | ||
| } | ||
| } | ||
Comment on lines +1 to +6 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. Is there a better way to do this? Specifically 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. Yep, this is good! | ||
272 changes: 272 additions & 0 deletionspackages/eslint-plugin/tests/rules/no-for-in-array.test.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
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.