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.

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

Jump to bottom

fix(eslint-plugin): [no-unused-vars] clear error report range #8640

Merged
merged 8 commits into from
Apr 28, 2024
+42 −10
Merged

fix(eslint-plugin): [no-unused-vars] clear error report range #8640

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
74944e5
fix: clear error code range
developer-bandi Mar 10, 2024
d95260e
test: add test code that cover end line
developer-bandi Mar 10, 2024
56ff4f2
refactor: rename variable name and delete not effect property
developer-bandi Apr 7, 2024
4062305
test: add test case
developer-bandi Apr 19, 2024
8819bd3
fix: remove type property
developer-bandi Apr 28, 2024
00c75a4
fix: remove type property
developer-bandi Apr 28, 2024
164798e
fix: remove type property
developer-bandi Apr 28, 2024
702b828
Merge branch 'main' into feat/no-unused-var-patch
kirkwaiblinger Apr 28, 2024
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
19 changes: 16 additions & 3 deletions packages/eslint-plugin/src/rules/no-unused-vars.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -419,10 +419,23 @@ export default createRule<Options, MessageIds>({
ref.from.variableScope === unusedVar.scope.variableScope,
);

const id = writeReferences.length
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Even though these branches collapse to do the same thing, I think it could be good to test both branches, in case one day they get separated (for example, to report different error messages)

What do you think about adding test cases with all 4 report loc fields for some cases like the following?

let foo: number;
let foo: number = 1;
foo = 2;
foo = 3;

? writeReferences[writeReferences.length - 1].identifier
: unusedVar.identifiers[0];

const { start } = id.loc;
const idLength = id.name.length;

const loc = {
start,
end: {
line: start.line,
column: start.column + idLength,
},
};

context.report({
node: writeReferences.length
? writeReferences[writeReferences.length - 1].identifier
: unusedVar.identifiers[0],
loc,
messageId: 'unusedVar',
data: unusedVar.references.some(ref => ref.isWrite())
? getAssignedMessageData(unusedVar)
Expand Down
8 changes: 1 addition & 7 deletions packages/eslint-plugin/tests/rules/no-unused-vars/no-unused-vars-eslint.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

import { RuleTester } from '@typescript-eslint/rule-tester';
import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
import { AST_NODE_TYPES } from '@typescript-eslint/utils';

import type { MessageIds } from '../../../src/rules/no-unused-vars';
import rule from '../../../src/rules/no-unused-vars';
Expand Down Expand Up @@ -40,7 +39,6 @@ ruleTester.defineRule('use-every-a', context => {
function definedError(
varName: string,
additional = '',
type = AST_NODE_TYPES.Identifier,
): TSESLint.TestCaseError<MessageIds> {
return {
messageId: 'unusedVar',
Expand All @@ -49,7 +47,6 @@ function definedError(
action: 'defined',
additional,
},
type,
};
}

Expand All @@ -63,7 +60,6 @@ function definedError(
function assignedError(
varName: string,
additional = '',
type = AST_NODE_TYPES.Identifier,
): TSESLint.TestCaseError<MessageIds> {
return {
messageId: 'unusedVar',
Expand All @@ -72,7 +68,6 @@ function assignedError(
action: 'assigned a value',
additional,
},
type,
};
}

Expand Down Expand Up @@ -1232,7 +1227,7 @@ function f() {
},
{
code: '/*global a */',
errors: [definedError('a', '', AST_NODE_TYPES.Program)],
errors: [definedError('a', '')],
},
{
code: `
Expand Down Expand Up @@ -1341,7 +1336,6 @@ function foo() {
messageId: 'unusedVar',
data: { varName: 'foo', action: 'defined', additional: '' },
line: 2,
type: AST_NODE_TYPES.Identifier,
},
],
},
Expand Down
25 changes: 25 additions & 0 deletions packages/eslint-plugin/tests/rules/no-unused-vars/no-unused-vars.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1140,7 +1140,9 @@ export class Foo {}
additional: '',
},
line: 2,
endLine: 2,
column: 10,
endColumn: 31,
},
],
},
Expand Down Expand Up @@ -1744,6 +1746,8 @@ declare module 'foo' {
messageId: 'unusedVar',
line: 3,
column: 8,
endLine: 3,
endColumn: 12,
data: {
varName: 'Test',
action: 'defined',
Expand Down Expand Up @@ -1840,6 +1844,8 @@ x = foo(x);
messageId: 'unusedVar',
line: 3,
column: 1,
endLine: 3,
endColumn: 2,
data: {
varName: 'x',
action: 'assigned a value',
Expand Down Expand Up @@ -1950,5 +1956,24 @@ export namespace Bar {
},
],
},
{
code: `
const foo: number = 1;
`,
errors: [
{
messageId: 'unusedVar',
data: {
varName: 'foo',
action: 'assigned a value',
additional: '',
},
line: 2,
column: 7,
endLine: 2,
endColumn: 10,
},
],
},
],
});