feat: Add `reportUsedIgnorePattern` option to `no-unused-vars` rule #17662

Pearce-Ropion · 2023-10-18T18:17:49Z

Prerequisites checklist

I have read the contributing guidelines.

What is the purpose of this pull request? (put an "X" next to an item)

What rule do you want to change?

no-unused-vars

What change do you want to make (place an "X" next to just one item)?

Generate more warnings
Generate fewer warnings
Implement autofix
Implement suggestions

How will the change be implemented (place an "X" next to just one item)?

A new option
A new default behavior
Other

Please provide some example code that this change will affect:

Example 1:

/* eslint no-unused-vars: ["error", { "varsIgnorePattern": "^_" }] */

const _a = 5;
const _b = _a + 5

Example 2:

/* eslint no-unused-vars: ["error", { "argsIgnorePattern": "^_" }] */

function foo(_a) {
  return _a + 5
}

Example 3:

/* eslint no-unused-vars: ["error", { "destructuredArrayIgnorePattern": "^_" }] */

const [ a, _b ] = items;
console.log(a + _b);

Example 4:

/* eslint no-unused-vars: ["error", { "caughtErrorsIgnorePattern": "^_" }] */

try {}
catch(_err) {
  console.error(_err);
}

What does the rule currently do for this code?

In all examples, no warnings are reported.

What will the rule do after it's changed?

When the new option reportUsedIgnorePattern is enabled, each of the examples above will report; indicating that a variable that has been marked as an ignored unused variable is being used.

What changes did you make? (Give an overview)

This change adds a new option reportUsedIgnorePattern to the no-unused-vars rule. When enabled, the rule will report any instances of variables that match any of the valid ignore pattern options when that variable is actually being used.

Resolves: #17568

Is there anything you'd like reviewers to focus on?

When finding all references in order to report on the correct nodes, it is also finding the variable declaration. So a question for the team would be which nodes should this option report on:

Should all references including the declaration be reported?
Should only the variable declaration be reported?
Should only references not including the declaration be reported

linux-foundation-easycla · 2023-10-18T18:17:54Z

The committers listed above are authorized under a signed CLA.

✅ login: Pearce-Ropion / name: Pearce Ropion (a364f2f, 12d57da, 418a092, d97b7fd, a91ea4f, 1eefec5, 9fa1956, 6a0b6b5)

eslint-github-bot · 2023-10-18T18:17:55Z

Hi @Pearce-Ropion!, thanks for the Pull Request

The pull request title isn't properly formatted. We ask that you update the pull request title to match this format, as we use it to generate changelogs and automate releases.

The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
There should be a space following the initial tag and colon, for example 'feat: Message'.
The first letter of the tag should be in lowercase

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here

netlify · 2023-10-18T18:17:55Z

✅ Deploy Preview for docs-eslint canceled.

Name	Link
🔨 Latest commit	`9fa1956`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-eslint/deploys/660398e1192bd30008c67bd6

lib/rules/no-unused-vars.js

mdjermanovic · 2023-10-20T19:52:42Z

Should all references including the declaration be reported?

Should only the variable declaration be reported?

Should only references not including the declaration be reported

Would it make sense to report only on the reasons the variable is considered used, which are usually its read references?

This is how it currently works:

/* eslint no-unused-vars: ["error", {
    varsIgnorePattern: "^_",
    reportUsedIgnorePattern: true
}] */

var _a; // not reported

_a = 1; // this is reported but doesn't seem relevant?

foo(_a); // this is also reported, ok

But this variable is considered used only because of the read reference so it might make sense to report like this:

/* eslint no-unused-vars: ["error", {
    varsIgnorePattern: "^_",
    reportUsedIgnorePattern: true
}] */

var _a; // not reported

_a = 1; // not reported

foo(_a); // reported

lib/rules/no-unused-vars.js

Pearce-Ropion · 2023-10-20T20:08:07Z

Should all references including the declaration be reported?

Should only the variable declaration be reported?

Should only references not including the declaration be reported

Would it make sense to report only on the reasons the variable is considered used, which are usually its read references?

This is how it currently works:
/* eslint no-unused-vars: ["error", {
    varsIgnorePattern: "^_",
    reportUsedIgnorePattern: true
}] */

var _a; // not reported

_a = 1; // this is reported but doesn't seem relevant?

foo(_a); // this is also reported, ok
But this variable is considered used only because of the read reference so it might make sense to report like this:
/* eslint no-unused-vars: ["error", {
    varsIgnorePattern: "^_",
    reportUsedIgnorePattern: true
}] */

var _a; // not reported

_a = 1; // not reported

foo(_a); // reported

That makes sense to me. I couldn't entirely remember what counted as used. However, I would also expect that a user shouldn't be allowed to write to an ignored unused variable since it should be unused.

lib/rules/no-unused-vars.js

github-actions · 2023-11-13T22:31:26Z

Hi everyone, it looks like we lost track of this pull request. Please review and see what the next steps are. This pull request will auto-close in 7 days without an update.

Pearce-Ropion · 2023-11-20T06:22:20Z

I changed it to skip all variable initializations but otherwise report on all references. I also doesn't check whether the variable scope matches anymore so it can handle variables defined in the outer scope which are used in an inner scope.

Pearce-Ropion · 2023-11-30T16:30:10Z

@mdjermanovic I think this is working as expected now. Can you think of any other cases that I could test for? Otherwise, I think we are good to go.

github-actions · 2023-12-10T22:31:19Z

Hi everyone, it looks like we lost track of this pull request. Please review and see what the next steps are. This pull request will auto-close in 7 days without an update.

mdjermanovic · 2023-12-15T19:20:26Z

@Pearce-Ropion apologies for the delay in reviewing this PR.

I changed it to skip all variable initializations but otherwise report on all references.

I'm not sure what the common use cases for the varsIgnorePattern option are, but if user has a code like the following where the rule doesn't report any errors:

/*eslint no-unused-vars: ["error", { varsIgnorePattern: "^_", reportUsedIgnorePattern: true }]*/

var _foo;

_foo = 5;

and then they add more code that causes the variable to be considered used, so that the rule now reports it:

/*eslint no-unused-vars: ["error", { varsIgnorePattern: "^_", reportUsedIgnorePattern: true }]*/

var _foo;

_foo = 5;

bar(_foo);

then, I think it makes the most sense to report only on the references where this rule considers the variable to be used: _foo in bar(_foo), because _foo = 5 has no effect on whether the variable is considered used, and it was valid before bar(_foo) was added.

Alternatively, we could report only the declaration assuming that the variable name is wrong because it was intended to be used (as opposed to reporting references, in which case the assumption is that the variable that wasn't intended to be used is mistakenly used).

Curious what others think about this.

mdjermanovic · 2024-01-25T14:39:54Z

In this case, the message seems misleading:

/*eslint no-unused-vars: ["error", {
    "reportUsedIgnorePattern": true,
    "destructuredArrayIgnorePattern": "^_",
    "varsIgnorePattern": "[iI]gnored"
}]*/

let _x; // '_x' is marked as ignored but is used. Used vars must not match /[iI]gnored/u.

[_x] = arr;

foo(_x);

tests/lib/rules/no-unused-vars.js

Tanujkanti4441 · 2024-02-16T07:00:31Z

Hi @Pearce-Ropion, some changes are requested. you can check out.

mdjermanovic · 2024-02-22T08:47:12Z

lib/rules/no-unused-vars.js

@@ -92,7 +103,8 @@ module.exports = {
            vars: "all",
            args: "after-used",
            ignoreRestSiblings: false,
-            caughtErrors: "all"
+            caughtErrors: "all",
+            reportUsedIgnorePattern: false,


Suggested change

reportUsedIgnorePattern: false,

reportUsedIgnorePattern: false

To fix the lint error.

mdjermanovic · 2024-02-22T09:33:45Z

In this case, the message seems misleading:

/*eslint no-unused-vars: ["error", {
    "reportUsedIgnorePattern": true,
    "destructuredArrayIgnorePattern": "^_",
    "varsIgnorePattern": "[iI]gnored"
}]*/

let _x; // '_x' is marked as ignored but is used. Used vars must not match /[iI]gnored/u.

[_x] = arr;

foo(_x);

I'm still getting the same error, looks like this case still hasn't been addressed?

mdjermanovic · 2024-02-22T09:43:02Z

Here's a similar case that should also be fixed:

/*eslint no-unused-vars: ["error", {
    "reportUsedIgnorePattern": true,
    "destructuredArrayIgnorePattern": "^_",
    "varsIgnorePattern": "[iI]gnored"
}]*/

const [ignored] = arr; // 'ignored' is marked as ignored but is used. Used elements of array destructuring must not match /^_/u.

foo(ignored);

The message should be: 'ignored' is marked as ignored but is used. Used vars must not match /[iI]gnored/u.

mdjermanovic · 2024-03-13T10:52:12Z

lib/rules/no-unused-vars.js

+                            if (config.reportUsedIgnorePattern && isUsedVariable(variable)) {
+                                usedIgnoredVars.push(variable);
+                            }


Instead of collecting these vars and later figuring out why they were considered as used ignored, we could just report them right away with the data we have at this point:

Suggested change

if (config.reportUsedIgnorePattern && isUsedVariable(variable)) {

usedIgnoredVars.push(variable);

}

if (config.reportUsedIgnorePattern && isUsedVariable(variable)) {

context.report({

node: def.name,

messageId: "usedIgnoredVar",

data: {

varName: variable.name,

additional: `. Used elements of array destructuring must not match ${config.destructuredArrayIgnorePattern}`

}

});

}

(the same for catch arguments, params and variables).

That would fix #17662 (comment) and #17662 (comment).

nzakas · 2024-03-22T19:12:44Z

@Pearce-Ropion are you still working on this?

Pearce-Ropion · 2024-03-22T23:11:12Z

@Pearce-Ropion are you still working on this?

Yes, apologies. I've been slammed with work. I'll get the proposed suggestions in this weekend

Address comments Fix tests Report on all variables except for initializers Report only on declarations Match message formatting with other rule messages Move variable.eslintUsed into isUsedVariable function Refactor report messages for consistency Fix tests

Pearce-Ropion · 2024-03-27T04:02:22Z

Ok, I've applied @mdjermanovic's suggestions to report as soon as we detect the used ignored variable. I also explicitly added the test cases that @mdjermanovic used.

I've also updated the message data handling. I had already updated the other message data handlers as per previous comments, but I noticed that all 3 of the message data getters were doing basically the same thing. So I've added a getVariableDescription helper function to get the required info for the message data base on the type of the variable that is currently being reported.

nzakas

LGTM. Would like @mdjermanovic to review before merging.

mdjermanovic

LGTM, thanks for contributing!

Pearce-Ropion requested a review from a team as a code owner October 18, 2023 18:17

Pearce-Ropion changed the title ~~Add reportUsedIgnorePattern option to no-unused-vars rule~~ feat: Add reportUsedIgnorePattern option to no-unused-vars rule Oct 18, 2023

eslint-github-bot bot added the feature This change adds a new feature to ESLint label Oct 18, 2023

costinsin reviewed Oct 19, 2023

View reviewed changes

lib/rules/no-unused-vars.js Outdated Show resolved Hide resolved

mdjermanovic reviewed Oct 20, 2023

View reviewed changes

lib/rules/no-unused-vars.js Outdated Show resolved Hide resolved

Tanujkanti4441 added the rule Relates to ESLint's core rules label Oct 23, 2023

Pearce-Ropion requested review from mdjermanovic and costinsin October 24, 2023 18:42

mdjermanovic requested changes Nov 3, 2023

View reviewed changes

lib/rules/no-unused-vars.js Outdated Show resolved Hide resolved

github-actions bot added the Stale label Nov 13, 2023

Tanujkanti4441 removed the Stale label Nov 14, 2023

Pearce-Ropion requested a review from mdjermanovic November 19, 2023 23:24

Tanujkanti4441 mentioned this pull request Nov 22, 2023

Rule Change: Add support for suggestions for unused var #17545

Open

1 task

github-actions bot added the Stale label Dec 10, 2023

Tanujkanti4441 removed the Stale label Dec 11, 2023

Tanujkanti4441 requested review from nzakas and snitin315 and removed request for costinsin December 11, 2023 02:46

mdjermanovic added accepted There is consensus among the team that this change meets the criteria for inclusion enhancement This change enhances an existing feature of ESLint labels Dec 15, 2023

mdjermanovic added the contributor pool label Jan 25, 2024

mdjermanovic reviewed Jan 25, 2024

View reviewed changes

tests/lib/rules/no-unused-vars.js Show resolved Hide resolved

tests/lib/rules/no-unused-vars.js Show resolved Hide resolved

tests/lib/rules/no-unused-vars.js Show resolved Hide resolved

Pearce-Ropion force-pushed the pearce/issue17568 branch from 1ae9983 to 1218fdc Compare February 22, 2024 04:16

Pearce-Ropion requested a review from mdjermanovic February 22, 2024 04:18

mdjermanovic reviewed Feb 22, 2024

View reviewed changes

Pearce-Ropion dismissed nzakas’s stale review via 1218fdc March 12, 2024 12:05

mdjermanovic reviewed Mar 13, 2024

View reviewed changes

Pearce-Ropion and others added 2 commits March 26, 2024 19:34

Report when ignored variable use used.

1eefec5

Pearce-Ropion force-pushed the pearce/issue17568 branch from 1218fdc to 1eefec5 Compare March 27, 2024 03:17

Pearce-Ropion added 6 commits March 26, 2024 20:21

Fix docs and jsdocs

6a0b6b5

Full revert jsdoc update

418a092

Refactor message data handlers

a91ea4f

Fix english

d97b7fd

english is hard

12d57da

Fix auto prettier

9fa1956

Pearce-Ropion requested review from mdjermanovic and nzakas March 27, 2024 04:02

nzakas approved these changes Mar 29, 2024

View reviewed changes

mdjermanovic approved these changes Apr 2, 2024

View reviewed changes

mdjermanovic merged commit 97ce45b into eslint:main Apr 2, 2024
19 checks passed

Lessy97 mentioned this pull request Apr 6, 2024

[Snyk] Security upgrade eslint from 8.57.0 to 9.0.0 Lessy97/eslint#3

Open

danilvilh66 mentioned this pull request Apr 6, 2024

[Snyk] Security upgrade eslint from 8.57.0 to 9.0.0 danilvilh66/eslint#2

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add `reportUsedIgnorePattern` option to `no-unused-vars` rule #17662

feat: Add `reportUsedIgnorePattern` option to `no-unused-vars` rule #17662

Pearce-Ropion commented Oct 18, 2023 •

edited

linux-foundation-easycla bot commented Oct 18, 2023 •

edited

eslint-github-bot bot commented Oct 18, 2023

netlify bot commented Oct 18, 2023 •

edited

mdjermanovic commented Oct 20, 2023

Pearce-Ropion commented Oct 20, 2023 •

edited

github-actions bot commented Nov 13, 2023

Pearce-Ropion commented Nov 20, 2023

Pearce-Ropion commented Nov 30, 2023

github-actions bot commented Dec 10, 2023

mdjermanovic commented Dec 15, 2023

mdjermanovic commented Jan 25, 2024

Tanujkanti4441 commented Feb 16, 2024

mdjermanovic Feb 22, 2024

mdjermanovic commented Feb 22, 2024

mdjermanovic commented Feb 22, 2024

mdjermanovic Mar 13, 2024

nzakas commented Mar 22, 2024

Pearce-Ropion commented Mar 22, 2024

Pearce-Ropion commented Mar 27, 2024

nzakas left a comment

mdjermanovic left a comment

	reportUsedIgnorePattern: false,
	reportUsedIgnorePattern: false

-                            if (config.reportUsedIgnorePattern && isUsedVariable(variable)) {
-                                usedIgnoredVars.push(variable);
-                            }
+                            if (config.reportUsedIgnorePattern && isUsedVariable(variable)) {
+                                context.report({
+                                    node: def.name,
+                                    messageId: "usedIgnoredVar",
+                                    data: {
+                                        varName: variable.name,
+                                        additional: `. Used elements of array destructuring must not match ${config.destructuredArrayIgnorePattern}`
+                                    }
+                                });
+                            }

feat: Add reportUsedIgnorePattern option to no-unused-vars rule #17662

feat: Add reportUsedIgnorePattern option to no-unused-vars rule #17662

Conversation

Pearce-Ropion commented Oct 18, 2023 • edited

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

What changes did you make? (Give an overview)

Is there anything you'd like reviewers to focus on?

linux-foundation-easycla bot commented Oct 18, 2023 • edited

eslint-github-bot bot commented Oct 18, 2023

netlify bot commented Oct 18, 2023 • edited

✅ Deploy Preview for docs-eslint canceled.

mdjermanovic commented Oct 20, 2023

Pearce-Ropion commented Oct 20, 2023 • edited

github-actions bot commented Nov 13, 2023

Pearce-Ropion commented Nov 20, 2023

Pearce-Ropion commented Nov 30, 2023

github-actions bot commented Dec 10, 2023

mdjermanovic commented Dec 15, 2023

mdjermanovic commented Jan 25, 2024

Tanujkanti4441 commented Feb 16, 2024

mdjermanovic Feb 22, 2024

Choose a reason for hiding this comment

mdjermanovic commented Feb 22, 2024

mdjermanovic commented Feb 22, 2024

mdjermanovic Mar 13, 2024

Choose a reason for hiding this comment

nzakas commented Mar 22, 2024

Pearce-Ropion commented Mar 22, 2024

Pearce-Ropion commented Mar 27, 2024

nzakas left a comment

Choose a reason for hiding this comment

mdjermanovic left a comment

Choose a reason for hiding this comment

feat: Add `reportUsedIgnorePattern` option to `no-unused-vars` rule #17662

feat: Add `reportUsedIgnorePattern` option to `no-unused-vars` rule #17662

Pearce-Ropion commented Oct 18, 2023 •

edited

linux-foundation-easycla bot commented Oct 18, 2023 •

edited

netlify bot commented Oct 18, 2023 •

edited

Pearce-Ropion commented Oct 20, 2023 •

edited