fix: destructuring in catch clause in no-unused-vars (#18636)

fasttime · web-flow · commit 14e9f81ccdb5 · 2024-07-12T22:13:30.000+02:00
* fix: destructuring in catch clause in `no-unused-vars`

* revert changes in `lib/rules/no-unused-vars.js`

* temporarily use repo branch for eslint-scope

* Update package.json
diff --git a/lib/rules/no-unused-vars.js b/lib/rules/no-unused-vars.js
@@ -340,7 +340,7 @@ module.exports = {
         /**
          * Determines if a variable has a sibling rest property
          * @param {Variable} variable eslint-scope variable object.
-         * @returns {boolean} True if the variable is exported, false if not.
+         * @returns {boolean} True if the variable has a sibling rest property, false if not.
          * @private
          */
         function hasRestSpreadSibling(variable) {
diff --git a/package.json b/package.json
@@ -79,7 +79,7 @@
     "cross-spawn": "^7.0.2",
     "debug": "^4.3.2",
     "escape-string-regexp": "^4.0.0",
-    "eslint-scope": "^8.0.1",
+    "eslint-scope": "^8.0.2",
     "eslint-visitor-keys": "^4.0.0",
     "espree": "^10.1.0",
     "esquery": "^1.5.0",
diff --git a/tests/lib/rules/no-unused-vars.js b/tests/lib/rules/no-unused-vars.js
@@ -270,6 +270,11 @@ ruleTester.run("no-unused-vars", rule, {
             options: [{ destructuredArrayIgnorePattern: "^_", ignoreRestSiblings: true }],
             languageOptions: { ecmaVersion: 2018 }
         },
+        {
+            code: "try {} catch ([firstError]) {}",
+            options: [{ destructuredArrayIgnorePattern: "Error$" }],
+            languageOptions: { ecmaVersion: 2015 }
+        },
 
         // for-in loops (see #2342)
         "(function(obj) { var name; for ( name in obj ) return; })({});",
@@ -316,6 +321,16 @@ ruleTester.run("no-unused-vars", rule, {
             code: "try{}catch(ignoreErr){}",
             options: [{ caughtErrors: "all", caughtErrorsIgnorePattern: "^ignore" }]
         },
+        {
+            code: "try {} catch ({ message, stack }) {}",
+            options: [{ caughtErrorsIgnorePattern: "message|stack" }],
+            languageOptions: { ecmaVersion: 2015 }
+        },
+        {
+            code: "try {} catch ({ errors: [firstError] }) {}",
+            options: [{ caughtErrorsIgnorePattern: "Error$" }],
+            languageOptions: { ecmaVersion: 2015 }
+        },
 
         // caughtErrors with other combinations
         {
@@ -329,6 +344,11 @@ ruleTester.run("no-unused-vars", rule, {
             options: [{ ignoreRestSiblings: true }],
             languageOptions: { ecmaVersion: 2018 }
         },
+        {
+            code: "try {} catch ({ foo, ...bar }) { console.log(bar); }",
+            options: [{ ignoreRestSiblings: true }],
+            languageOptions: { ecmaVersion: 2018 }
+        },
 
         // https://github.com/eslint/eslint/issues/6348
         "var a = 0, b; b = a = a + 1; foo(b);",
@@ -1674,6 +1694,30 @@ c = foo1`,
             options: [{ caughtErrors: "all", caughtErrorsIgnorePattern: "^_", reportUsedIgnorePattern: true }],
             errors: [usedIgnoredError("_err", ". Used caught errors must not match /^_/u")]
         },
+        {
+            code: "try {} catch ({ message }) { console.error(message); }",
+            options: [{ caughtErrorsIgnorePattern: "message", reportUsedIgnorePattern: true }],
+            languageOptions: { ecmaVersion: 2015 },
+            errors: [usedIgnoredError("message", ". Used caught errors must not match /message/u")]
+        },
+        {
+            code: "try {} catch ([_a, _b]) { doSomething(_a, _b); }",
+            options: [{ caughtErrorsIgnorePattern: "^_", reportUsedIgnorePattern: true }],
+            languageOptions: { ecmaVersion: 6 },
+            errors: [
+                usedIgnoredError("_a", ". Used caught errors must not match /^_/u"),
+                usedIgnoredError("_b", ". Used caught errors must not match /^_/u")
+            ]
+        },
+        {
+            code: "try {} catch ([_a, _b]) { doSomething(_a, _b); }",
+            options: [{ destructuredArrayIgnorePattern: "^_", reportUsedIgnorePattern: true }],
+            languageOptions: { ecmaVersion: 6 },
+            errors: [
+                usedIgnoredError("_a", ". Used elements of array destructuring must not match /^_/u"),
+                usedIgnoredError("_b", ". Used elements of array destructuring must not match /^_/u")
+            ]
+        },
         {
             code: `
 try {
@@ -1705,6 +1749,35 @@ try {
                 }
             ]
         },
+        {
+            code: "try {} catch ({ message, errors: [firstError] }) {}",
+            options: [{ caughtErrorsIgnorePattern: "foo" }],
+            languageOptions: { ecmaVersion: 2015 },
+            errors: [
+                {
+                    message: "'message' is defined but never used. Allowed unused caught errors must match /foo/u.",
+                    column: 17,
+                    endColumn: 24
+                },
+                {
+                    message: "'firstError' is defined but never used. Allowed unused caught errors must match /foo/u.",
+                    column: 35,
+                    endColumn: 45
+                }
+            ]
+        },
+        {
+            code: "try {} catch ({ stack: $ }) { $ = 'Something broke: ' + $; }",
+            options: [{ caughtErrorsIgnorePattern: "\\w" }],
+            languageOptions: { ecmaVersion: 2015 },
+            errors: [
+                {
+                    message: "'$' is assigned a value but never used. Allowed unused caught errors must match /\\w/u.",
+                    column: 31,
+                    endColumn: 32
+                }
+            ]
+        },
         {
             code: `
 _ => { _ = _ + 1 };
