fix(eslint-plugin): [no-unused-vars] fix race condition between naming-convention and no-unused-vars (typescript-eslint#2848)

bradzacher · web-flow · commit ccb6b9499a4a · 2020-12-03T18:42:59.000-08:00
Fixes typescript-eslint#2844
diff --git a/packages/eslint-plugin/src/rules/no-unused-vars.ts b/packages/eslint-plugin/src/rules/no-unused-vars.ts
@@ -238,9 +238,17 @@ export default util.createRule<Options, MessageIds>({
           }
         }
 
-        if (!hasRestSpreadSibling(variable)) {
-          unusedVariablesReturn.push(variable);
+        if (hasRestSpreadSibling(variable)) {
+          continue;
+        }
+
+        // in case another rule has run and used the collectUnusedVariables,
+        // we want to ensure our selectors that marked variables as used are respected
+        if (variable.eslintUsed) {
+          continue;
         }
+
+        unusedVariablesReturn.push(variable);
       }
 
       return unusedVariablesReturn;
diff --git a/packages/eslint-plugin/tests/rules/no-unused-vars/no-unused-vars.test.ts b/packages/eslint-plugin/tests/rules/no-unused-vars/no-unused-vars.test.ts
@@ -1,4 +1,5 @@
 import rule from '../../../src/rules/no-unused-vars';
+import { collectUnusedVariables } from '../../../src/util';
 import { noFormat, RuleTester } from '../../RuleTester';
 
 const ruleTester = new RuleTester({
@@ -10,6 +11,12 @@ const ruleTester = new RuleTester({
   parser: '@typescript-eslint/parser',
 });
 
+// this is used to ensure that the caching the utility does does not impact the results done by no-unused-vars
+ruleTester.defineRule('collect-unused-vars', context => {
+  collectUnusedVariables(context);
+  return {};
+});
+
 ruleTester.run('no-unused-vars', rule, {
   valid: [
     `
@@ -960,8 +967,17 @@ interface _Foo {
       // ignored by pattern, even though it's only self-referenced
       options: [{ varsIgnorePattern: '^_' }],
     },
-    // https://github.com/ocavue/typescript-eslint-issue-2831/blob/master/index.ts
-    'export const classes = [class C1 {}, class C2 {}, class C3 {}];',
+    // https://github.com/typescript-eslint/typescript-eslint/issues/2844
+    `
+/* eslint collect-unused-vars: "error" */
+declare module 'next-auth' {
+  interface User {
+    id: string;
+    givenName: string;
+    familyName: string;
+  }
+}
+    `,
   ],
 
   invalid: [

Original file line number	Diff line number	Diff line change
`@@ -238,9 +238,17 @@ export default util.createRule<Options, MessageIds>({`
`238`	`238`	`}`
`239`	`239`	`}`
`240`	`240`
`241`		`- if (!hasRestSpreadSibling(variable)) {`
`242`		`- unusedVariablesReturn.push(variable);`
	`241`	`+ if (hasRestSpreadSibling(variable)) {`
	`242`	`+ continue;`
	`243`	`+ }`
	`244`	`+`
	`245`	`+ // in case another rule has run and used the collectUnusedVariables,`
	`246`	`+ // we want to ensure our selectors that marked variables as used are respected`
	`247`	`+ if (variable.eslintUsed) {`
	`248`	`+ continue;`
`243`	`249`	`}`
	`250`	`+`
	`251`	`+ unusedVariablesReturn.push(variable);`
`244`	`252`	`}`
`245`	`253`
`246`	`254`	`return unusedVariablesReturn;`