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.

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

fix(eslint-plugin): [no-for-in-array] refine report location #8874

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion packages/eslint-plugin/src/rules/no-for-in-array.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
getParserServices,
isTypeArrayTypeOrUnionOfArrayTypes,
} from '../util';
import { getForStatementHeadLoc } from '../util/getForStatementHeadLoc';

export default createRule({
name: 'no-for-in-array',
Expand Down Expand Up @@ -36,7 +37,7 @@ export default createRule({
(type.flags & ts.TypeFlags.StringLike) !== 0
) {
context.report({
node,
loc: getForStatementHeadLoc(context.sourceCode, node),
messageId: 'forInViolation',
});
}
Expand Down
34 changes: 34 additions & 0 deletions packages/eslint-plugin/src/util/getForStatementHeadLoc.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
import { nullThrows } from '@typescript-eslint/utils/eslint-utils';

/**
* Gets the location of the head of the given for statement variant for reporting.
*
* - `for (const foo in bar) expressionOrBlock`
* ^^^^^^^^^^^^^^^^^^^^^^
*
* - `for (const foo of bar) expressionOrBlock`
* ^^^^^^^^^^^^^^^^^^^^^^
*
* - `for await (const foo of bar) expressionOrBlock`
* ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
*
* - `for (let i = 0; i < 10; i++) expressionOrBlock`
* ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
*/
export function getForStatementHeadLoc(
sourceCode: TSESLint.SourceCode,
node:
| TSESTree.ForInStatement
| TSESTree.ForOfStatement
| TSESTree.ForStatement,
): TSESTree.SourceLocation {
const closingParens = nullThrows(
sourceCode.getTokenBefore(node.body, token => token.value === ')'),
'for statement must have a closing parenthesis.',
);
return {
start: structuredClone(node.loc.start),
end: structuredClone(closingParens.loc.end),
};
}

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

90 changes: 83 additions & 7 deletions packages/eslint-plugin/tests/rules/no-for-in-array.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import { RuleTester } from '@typescript-eslint/rule-tester';
import { AST_NODE_TYPES } from '@typescript-eslint/utils';
import { noFormat, RuleTester } from '@typescript-eslint/rule-tester';

import rule from '../../src/rules/no-for-in-array';
import { getFixturesRootDir } from '../RuleTester';
Expand Down Expand Up @@ -38,7 +37,10 @@ for (const x in [3, 4, 5]) {
errors: [
{
messageId: 'forInViolation',
type: AST_NODE_TYPES.ForInStatement,
line: 2,
column: 1,
endLine: 2,
endColumn: 27,
},
],
},
Expand All @@ -52,7 +54,10 @@ for (const x in z) {
errors: [
{
messageId: 'forInViolation',
type: AST_NODE_TYPES.ForInStatement,
line: 3,
column: 1,
endLine: 3,
endColumn: 19,
},
],
},
Expand All @@ -67,7 +72,10 @@ const fn = (arr: number[]) => {
errors: [
{
messageId: 'forInViolation',
type: AST_NODE_TYPES.ForInStatement,
line: 3,
column: 3,
endLine: 3,
endColumn: 23,
},
],
},
Expand All @@ -82,7 +90,10 @@ const fn = (arr: number[] | string[]) => {
errors: [
{
messageId: 'forInViolation',
type: AST_NODE_TYPES.ForInStatement,
line: 3,
column: 3,
endLine: 3,
endColumn: 23,
},
],
},
Expand All @@ -97,7 +108,72 @@ const fn = <T extends any[]>(arr: T) => {
errors: [
{
messageId: 'forInViolation',
type: AST_NODE_TYPES.ForInStatement,
line: 3,
column: 3,
endLine: 3,
endColumn: 23,
},
],
},
{
code: noFormat`
for (const x
in
(
(
(
[3, 4, 5]
)
)
)
)
// weird
/* spot for a */
// comment
/* ) */
/* ( */
{
console.log(x);
}
`,
errors: [
{
messageId: 'forInViolation',
line: 2,
column: 1,
endLine: 11,
endColumn: 4,
},
],
},
{
code: noFormat`
for (const x
in
(
(
(
[3, 4, 5]
)
)
)
)
// weird
/* spot for a */
// comment
/* ) */
/* ( */

((((console.log('body without braces ')))));

`,
errors: [
{
messageId: 'forInViolation',
line: 2,
column: 1,
endLine: 11,
endColumn: 4,
},
],
},
Expand Down