refactor: update default options in rules (#19136)

mdjermanovic · web-flow · commit 45cd4ead9c4f · 2024-11-20T07:30:45.000+01:00
diff --git a/lib/rules/accessor-pairs.js b/lib/rules/accessor-pairs.js
@@ -177,10 +177,11 @@ module.exports = {
         }
     },
     create(context) {
-        const [config] = context.options;
-        const checkGetWithoutSet = config.getWithoutSet === true;
-        const checkSetWithoutGet = config.setWithoutGet !== false;
-        const enforceForClassMembers = config.enforceForClassMembers !== false;
+        const [{
+            getWithoutSet: checkGetWithoutSet,
+            setWithoutGet: checkSetWithoutGet,
+            enforceForClassMembers
+        }] = context.options;
         const sourceCode = context.sourceCode;
 
         /**
diff --git a/lib/rules/getter-return.js b/lib/rules/getter-return.js
@@ -42,7 +42,9 @@ module.exports = {
     meta: {
         type: "problem",
 
-        defaultOptions: [{}],
+        defaultOptions: [{
+            allowImplicit: false
+        }],
 
         docs: {
             description: "Enforce `return` statements in getters",
diff --git a/lib/rules/id-length.js b/lib/rules/id-length.js
@@ -25,7 +25,8 @@ module.exports = {
         defaultOptions: [{
             exceptionPatterns: [],
             exceptions: [],
-            min: 2
+            min: 2,
+            properties: "always"
         }],
 
         docs: {
diff --git a/lib/rules/id-match.js b/lib/rules/id-match.js
@@ -20,7 +20,12 @@ module.exports = {
     meta: {
         type: "suggestion",
 
-        defaultOptions: ["^.+$", {}],
+        defaultOptions: ["^.+$", {
+            classFields: false,
+            ignoreDestructuring: false,
+            onlyDeclarations: false,
+            properties: false
+        }],
 
         docs: {
             description: "Require identifiers to match a specified regular expression",
diff --git a/lib/rules/new-cap.js b/lib/rules/new-cap.js
@@ -118,7 +118,7 @@ module.exports = {
 
     create(context) {
         const [config] = context.options;
-        const skipProperties = config.properties === false;
+        const skipProperties = !config.properties;
 
         const newIsCapExceptions = config.newIsCapExceptions.reduce(invert, {});
         const newIsCapExceptionPattern = config.newIsCapExceptionPattern ? new RegExp(config.newIsCapExceptionPattern, "u") : null;
diff --git a/lib/rules/no-bitwise.js b/lib/rules/no-bitwise.js
@@ -25,7 +25,10 @@ module.exports = {
     meta: {
         type: "suggestion",
 
-        defaultOptions: [{ allow: [] }],
+        defaultOptions: [{
+            allow: [],
+            int32Hint: false
+        }],
 
         docs: {
             description: "Disallow bitwise operators",
diff --git a/lib/rules/no-duplicate-imports.js b/lib/rules/no-duplicate-imports.js
@@ -232,7 +232,9 @@ module.exports = {
     meta: {
         type: "problem",
 
-        defaultOptions: [{}],
+        defaultOptions: [{
+            includeExports: false
+        }],
 
         docs: {
             description: "Disallow duplicate module imports",
diff --git a/lib/rules/no-empty-pattern.js b/lib/rules/no-empty-pattern.js
@@ -15,7 +15,9 @@ module.exports = {
     meta: {
         type: "problem",
 
-        defaultOptions: [{}],
+        defaultOptions: [{
+            allowObjectPatternsAsParameters: false
+        }],
 
         docs: {
             description: "Disallow empty destructuring patterns",
diff --git a/lib/rules/no-eval.js b/lib/rules/no-eval.js
@@ -42,7 +42,9 @@ module.exports = {
     meta: {
         type: "suggestion",
 
-        defaultOptions: [{}],
+        defaultOptions: [{
+            allowIndirect: false
+        }],
 
         docs: {
             description: "Disallow the use of `eval()`",
diff --git a/lib/rules/no-implicit-globals.js b/lib/rules/no-implicit-globals.js
@@ -14,7 +14,9 @@ module.exports = {
     meta: {
         type: "suggestion",
 
-        defaultOptions: [{}],
+        defaultOptions: [{
+            lexicalBindings: false
+        }],
 
         docs: {
             description: "Disallow declarations in the global scope",
diff --git a/lib/rules/no-inner-declarations.js b/lib/rules/no-inner-declarations.js
@@ -47,7 +47,7 @@ module.exports = {
     meta: {
         type: "problem",
 
-        defaultOptions: ["functions"],
+        defaultOptions: ["functions", { blockScopedFunctions: "allow" }],
 
         docs: {
             description: "Disallow variable or `function` declarations in nested blocks",
@@ -77,10 +77,10 @@ module.exports = {
 
     create(context) {
         const both = context.options[0] === "both";
+        const { blockScopedFunctions } = context.options[1];
 
         const sourceCode = context.sourceCode;
         const ecmaVersion = context.languageOptions.ecmaVersion;
-        const blockScopedFunctions = context.options[1]?.blockScopedFunctions ?? "allow";
 
         /**
          * Ensure that a given node is at a program or function body's root.
diff --git a/lib/rules/no-multi-assign.js b/lib/rules/no-multi-assign.js
@@ -15,7 +15,9 @@ module.exports = {
     meta: {
         type: "suggestion",
 
-        defaultOptions: [{}],
+        defaultOptions: [{
+            ignoreNonDeclaration: false
+        }],
 
         docs: {
             description: "Disallow use of chained assignment expressions",
diff --git a/lib/rules/no-plusplus.js b/lib/rules/no-plusplus.js
@@ -50,7 +50,9 @@ module.exports = {
     meta: {
         type: "suggestion",
 
-        defaultOptions: [{}],
+        defaultOptions: [{
+            allowForLoopAfterthoughts: false
+        }],
 
         docs: {
             description: "Disallow the unary operators `++` and `--`",
diff --git a/lib/rules/no-promise-executor-return.js b/lib/rules/no-promise-executor-return.js
@@ -141,7 +141,9 @@ module.exports = {
     meta: {
         type: "problem",
 
-        defaultOptions: [{}],
+        defaultOptions: [{
+            allowVoid: false
+        }],
 
         docs: {
             description: "Disallow returning values from Promise executor functions",
diff --git a/lib/rules/no-shadow.js b/lib/rules/no-shadow.js
@@ -31,7 +31,9 @@ module.exports = {
 
         defaultOptions: [{
             allow: [],
-            hoist: "functions"
+            builtinGlobals: false,
+            hoist: "functions",
+            ignoreOnInitialization: false
         }],
 
         docs: {
@@ -45,7 +47,7 @@ module.exports = {
                 type: "object",
                 properties: {
                     builtinGlobals: { type: "boolean" },
-                    hoist: { enum: ["all", "functions", "never"], default: "functions" },
+                    hoist: { enum: ["all", "functions", "never"] },
                     allow: {
                         type: "array",
                         items: {
diff --git a/lib/rules/no-undef.js b/lib/rules/no-undef.js
@@ -28,7 +28,9 @@ module.exports = {
     meta: {
         type: "problem",
 
-        defaultOptions: [{}],
+        defaultOptions: [{
+            typeof: false
+        }],
 
         docs: {
             description: "Disallow the use of undeclared variables unless mentioned in `/*global */` comments",
diff --git a/lib/rules/no-underscore-dangle.js b/lib/rules/no-underscore-dangle.js
@@ -22,6 +22,7 @@ module.exports = {
             allowFunctionParams: true,
             allowInArrayDestructuring: true,
             allowInObjectDestructuring: true,
+            enforceInClassFields: false,
             enforceInMethodNames: false
         }],
 
diff --git a/lib/rules/no-unsafe-negation.js b/lib/rules/no-unsafe-negation.js
@@ -51,7 +51,9 @@ module.exports = {
     meta: {
         type: "problem",
 
-        defaultOptions: [{}],
+        defaultOptions: [{
+            enforceForOrderingRelations: false
+        }],
 
         docs: {
             description: "Disallow negating the left operand of relational operators",
diff --git a/lib/rules/no-unsafe-optional-chaining.js b/lib/rules/no-unsafe-optional-chaining.js
@@ -23,7 +23,9 @@ module.exports = {
     meta: {
         type: "problem",
 
-        defaultOptions: [{}],
+        defaultOptions: [{
+            disallowArithmeticOperators: false
+        }],
 
         docs: {
             description: "Disallow use of optional chaining in contexts where the `undefined` value is not allowed",
diff --git a/lib/rules/no-use-before-define.js b/lib/rules/no-use-before-define.js
@@ -249,7 +249,8 @@ module.exports = {
         defaultOptions: [{
             classes: true,
             functions: true,
-            variables: true
+            variables: true,
+            allowNamedExports: false
         }],
 
         messages: {
diff --git a/lib/rules/no-useless-computed-key.js b/lib/rules/no-useless-computed-key.js
@@ -120,7 +120,7 @@ module.exports = {
     },
     create(context) {
         const sourceCode = context.sourceCode;
-        const enforceForClassMembers = context.options[0]?.enforceForClassMembers ?? true;
+        const [{ enforceForClassMembers }] = context.options;
 
         /**
          * Reports a given node if it violated this rule.
diff --git a/lib/rules/no-useless-rename.js b/lib/rules/no-useless-rename.js
@@ -20,7 +20,11 @@ module.exports = {
     meta: {
         type: "suggestion",
 
-        defaultOptions: [{}],
+        defaultOptions: [{
+            ignoreDestructuring: false,
+            ignoreImport: false,
+            ignoreExport: false
+        }],
 
         docs: {
             description: "Disallow renaming import, export, and destructured assignments to the same name",
diff --git a/lib/rules/no-void.js b/lib/rules/no-void.js
@@ -13,7 +13,9 @@ module.exports = {
     meta: {
         type: "suggestion",
 
-        defaultOptions: [{}],
+        defaultOptions: [{
+            allowAsStatement: false
+        }],
 
         docs: {
             description: "Disallow `void` operators",
diff --git a/lib/rules/prefer-const.js b/lib/rules/prefer-const.js
@@ -331,7 +331,10 @@ module.exports = {
     meta: {
         type: "suggestion",
 
-        defaultOptions: [{ destructuring: "any" }],
+        defaultOptions: [{
+            destructuring: "any",
+            ignoreReadBeforeAssign: false
+        }],
 
         docs: {
             description: "Require `const` declarations for variables that are never reassigned after declared",
@@ -357,10 +360,9 @@ module.exports = {
     },
 
     create(context) {
-        const [options] = context.options;
+        const [{ destructuring, ignoreReadBeforeAssign }] = context.options;
+        const shouldMatchAnyDestructuredVariable = destructuring !== "all";
         const sourceCode = context.sourceCode;
-        const shouldMatchAnyDestructuredVariable = options.destructuring !== "all";
-        const ignoreReadBeforeAssign = options.ignoreReadBeforeAssign === true;
         const variables = [];
         let reportCount = 0;
         let checkedId = null;
diff --git a/lib/rules/prefer-promise-reject-errors.js b/lib/rules/prefer-promise-reject-errors.js
@@ -15,7 +15,9 @@ module.exports = {
     meta: {
         type: "suggestion",
 
-        defaultOptions: [{}],
+        defaultOptions: [{
+            allowEmptyReject: false
+        }],
 
         docs: {
             description: "Require using Error objects as Promise rejection reasons",
diff --git a/lib/rules/prefer-regex-literals.js b/lib/rules/prefer-regex-literals.js
@@ -112,7 +112,9 @@ module.exports = {
     meta: {
         type: "suggestion",
 
-        defaultOptions: [{}],
+        defaultOptions: [{
+            disallowRedundantWrapping: false
+        }],
 
         docs: {
             description: "Disallow use of the `RegExp` constructor in favor of regular expression literals",
diff --git a/lib/rules/require-atomic-updates.js b/lib/rules/require-atomic-updates.js
@@ -170,7 +170,9 @@ module.exports = {
     meta: {
         type: "problem",
 
-        defaultOptions: [{}],
+        defaultOptions: [{
+            allowProperties: false
+        }],
 
         docs: {
             description: "Disallow assignments that can lead to race conditions due to usage of `await` or `yield`",
diff --git a/lib/rules/sort-vars.js b/lib/rules/sort-vars.js
@@ -14,7 +14,9 @@ module.exports = {
     meta: {
         type: "suggestion",
 
-        defaultOptions: [{}],
+        defaultOptions: [{
+            ignoreCase: false
+        }],
 
         docs: {
             description: "Require variables within the same declaration block to be sorted",
@@ -27,8 +29,7 @@ module.exports = {
                 type: "object",
                 properties: {
                     ignoreCase: {
-                        type: "boolean",
-                        default: false
+                        type: "boolean"
                     }
                 },
                 additionalProperties: false
diff --git a/lib/rules/use-isnan.js b/lib/rules/use-isnan.js
@@ -84,8 +84,7 @@ module.exports = {
 
     create(context) {
 
-        const enforceForSwitchCase = !context.options[0] || context.options[0].enforceForSwitchCase;
-        const enforceForIndexOf = context.options[0] && context.options[0].enforceForIndexOf;
+        const [{ enforceForIndexOf, enforceForSwitchCase }] = context.options;
         const sourceCode = context.sourceCode;
 
         const fixableOperators = new Set(["==", "===", "!=", "!=="]);
diff --git a/lib/rules/valid-typeof.js b/lib/rules/valid-typeof.js
@@ -19,7 +19,9 @@ module.exports = {
     meta: {
         type: "problem",
 
-        defaultOptions: [{}],
+        defaultOptions: [{
+            requireStringLiterals: false
+        }],
 
         docs: {
             description: "Enforce comparing `typeof` expressions against valid strings",
@@ -34,8 +36,7 @@ module.exports = {
                 type: "object",
                 properties: {
                     requireStringLiterals: {
-                        type: "boolean",
-                        default: false
+                        type: "boolean"
                     }
                 },
                 additionalProperties: false
diff --git a/tests/lib/rules/consistent-return.js b/tests/lib/rules/consistent-return.js
@@ -36,6 +36,8 @@ ruleTester.run("consistent-return", rule, {
         "function foo() { function bar() { return true; } return; }",
         "function foo() { function bar() { return; } return false; }",
         "function Foo() { if (!(this instanceof Foo)) return new Foo(); }",
+        "function foo() { if (true) return 5; else return undefined; }",
+        "function foo() { if (true) return 5; else return void 0; }",
         { code: "function foo() { if (true) return; else return undefined; }", options: [{ treatUndefinedAsUnspecified: true }] },
         { code: "function foo() { if (true) return; else return void 0; }", options: [{ treatUndefinedAsUnspecified: true }] },
         { code: "function foo() { if (true) return undefined; else return; }", options: [{ treatUndefinedAsUnspecified: true }] },
diff --git a/tests/lib/rules/id-match.js b/tests/lib/rules/id-match.js
diff --git a/tests/lib/rules/no-bitwise.js b/tests/lib/rules/no-bitwise.js
diff --git a/tests/lib/rules/no-irregular-whitespace.js b/tests/lib/rules/no-irregular-whitespace.js
diff --git a/tests/lib/rules/sort-imports.js b/tests/lib/rules/sort-imports.js
diff --git a/tests/lib/rules/sort-keys.js b/tests/lib/rules/sort-keys.js
