eslint 8.22.0 → 8.33.0

package/lib/options.js

@@ -63,261 +63,315 @@ const optionator = require("optionator");
 //------------------------------------------------------------------------------
 
 // exports "parse(args)", "generateHelp()", and "generateHelpForOption(optionName)"
-module.exports = optionator({
-    prepend: "eslint [options] file.js [file.js] [dir]",
-    defaults: {
-        concatRepeatedArrays: true,
-        mergeRepeatedObjects: true
-    },
-    options: [
-        {
-            heading: "Basic configuration"
-        },
-        {
+
+/**
+ * Creates the CLI options for ESLint.
+ * @param {boolean} usingFlatConfig Indicates if flat config is being used.
+ * @returns {Object} The optionator instance.
+ */
+module.exports = function(usingFlatConfig) {
+
+    let lookupFlag;
+
+    if (usingFlatConfig) {
+        lookupFlag = {
+            option: "config-lookup",
+            type: "Boolean",
+            default: "true",
+            description: "Disable look up for eslint.config.js"
+        };
+    } else {
+        lookupFlag = {
             option: "eslintrc",
             type: "Boolean",
             default: "true",
             description: "Disable use of configuration from .eslintrc.*"
-        },
-        {
-            option: "config",
-            alias: "c",
-            type: "path::String",
-            description: "Use this configuration, overriding .eslintrc.* config options if present"
-        },
-        {
+        };
+    }
+
+    let envFlag;
+
+    if (!usingFlatConfig) {
+        envFlag = {
             option: "env",
             type: "[String]",
             description: "Specify environments"
-        },
-        {
+        };
+    }
+
+    let extFlag;
+
+    if (!usingFlatConfig) {
+        extFlag = {
             option: "ext",
             type: "[String]",
             description: "Specify JavaScript file extensions"
-        },
-        {
-            option: "global",
-            type: "[String]",
-            description: "Define global variables"
-        },
-        {
-            option: "parser",
-            type: "String",
-            description: "Specify the parser to be used"
-        },
-        {
-            option: "parser-options",
-            type: "Object",
-            description: "Specify parser options"
-        },
-        {
+        };
+    }
+
+    let resolvePluginsFlag;
+
+    if (!usingFlatConfig) {
+        resolvePluginsFlag = {
             option: "resolve-plugins-relative-to",
             type: "path::String",
             description: "A folder where plugins should be resolved from, CWD by default"
-        },
-        {
-            heading: "Specifying rules and plugins"
-        },
-        {
-            option: "plugin",
-            type: "[String]",
-            description: "Specify plugins"
-        },
-        {
-            option: "rule",
-            type: "Object",
-            description: "Specify rules"
-        },
-        {
+        };
+    }
+
+    let rulesDirFlag;
+
+    if (!usingFlatConfig) {
+        rulesDirFlag = {
             option: "rulesdir",
             type: "[path::String]",
             description: "Load additional rules from this directory. Deprecated: Use rules from plugins"
-        },
-        {
-            heading: "Fixing problems"
-        },
-        {
-            option: "fix",
-            type: "Boolean",
-            default: false,
-            description: "Automatically fix problems"
-        },
-        {
-            option: "fix-dry-run",
-            type: "Boolean",
-            default: false,
-            description: "Automatically fix problems without saving the changes to the file system"
-        },
-        {
-            option: "fix-type",
-            type: "Array",
-            description: "Specify the types of fixes to apply (directive, problem, suggestion, layout)"
-        },
-        {
-            heading: "Ignoring files"
-        },
-        {
+        };
+    }
+
+    let ignorePathFlag;
+
+    if (!usingFlatConfig) {
+        ignorePathFlag = {
             option: "ignore-path",
             type: "path::String",
             description: "Specify path of ignore file"
-        },
-        {
-            option: "ignore",
-            type: "Boolean",
-            default: "true",
-            description: "Disable use of ignore files and patterns"
-        },
-        {
-            option: "ignore-pattern",
-            type: "[String]",
-            description: "Pattern of files to ignore (in addition to those in .eslintignore)",
-            concatRepeatedArrays: [true, {
-                oneValuePerFlag: true
-            }]
-        },
-        {
-            heading: "Using stdin"
-        },
-        {
-            option: "stdin",
-            type: "Boolean",
-            default: "false",
-            description: "Lint code provided on <STDIN>"
-        },
-        {
-            option: "stdin-filename",
-            type: "String",
-            description: "Specify filename to process STDIN as"
-        },
-        {
-            heading: "Handling warnings"
-        },
-        {
-            option: "quiet",
-            type: "Boolean",
-            default: "false",
-            description: "Report errors only"
-        },
-        {
-            option: "max-warnings",
-            type: "Int",
-            default: "-1",
-            description: "Number of warnings to trigger nonzero exit code"
-        },
-        {
-            heading: "Output"
-        },
-        {
-            option: "output-file",
-            alias: "o",
-            type: "path::String",
-            description: "Specify file to write report to"
-        },
-        {
-            option: "format",
-            alias: "f",
-            type: "String",
-            default: "stylish",
-            description: "Use a specific output format"
-        },
-        {
-            option: "color",
-            type: "Boolean",
-            alias: "no-color",
-            description: "Force enabling/disabling of color"
-        },
-        {
-            heading: "Inline configuration comments"
-        },
-        {
-            option: "inline-config",
-            type: "Boolean",
-            default: "true",
-            description: "Prevent comments from changing config or rules"
-        },
-        {
-            option: "report-unused-disable-directives",
-            type: "Boolean",
-            default: void 0,
-            description: "Adds reported errors for unused eslint-disable directives"
-        },
-        {
-            heading: "Caching"
-        },
-        {
-            option: "cache",
-            type: "Boolean",
-            default: "false",
-            description: "Only check changed files"
-        },
-        {
-            option: "cache-file",
-            type: "path::String",
-            default: ".eslintcache",
-            description: "Path to the cache file. Deprecated: use --cache-location"
-        },
-        {
-            option: "cache-location",
-            type: "path::String",
-            description: "Path to the cache file or directory"
-        },
-        {
-            option: "cache-strategy",
-            dependsOn: ["cache"],
-            type: "String",
-            default: "metadata",
-            enum: ["metadata", "content"],
-            description: "Strategy to use for detecting changed files in the cache"
-        },
-        {
-            heading: "Miscellaneous"
-        },
-        {
-            option: "init",
-            type: "Boolean",
-            default: "false",
-            description: "Run config initialization wizard"
-        },
-        {
-            option: "env-info",
-            type: "Boolean",
-            default: "false",
-            description: "Output execution environment information"
-        },
-        {
-            option: "error-on-unmatched-pattern",
-            type: "Boolean",
-            default: "true",
-            description: "Prevent errors when pattern is unmatched"
-        },
-        {
-            option: "exit-on-fatal-error",
-            type: "Boolean",
-            default: "false",
-            description: "Exit with exit code 2 in case of fatal error"
-        },
-        {
-            option: "debug",
-            type: "Boolean",
-            default: false,
-            description: "Output debugging information"
-        },
-        {
-            option: "help",
-            alias: "h",
-            type: "Boolean",
-            description: "Show help"
-        },
-        {
-            option: "version",
-            alias: "v",
-            type: "Boolean",
-            description: "Output the version number"
-        },
-        {
-            option: "print-config",
-            type: "path::String",
-            description: "Print the configuration for the given file"
-        }
-    ]
-});
+        };
+    }
+
+    return optionator({
+        prepend: "eslint [options] file.js [file.js] [dir]",
+        defaults: {
+            concatRepeatedArrays: true,
+            mergeRepeatedObjects: true
+        },
+        options: [
+            {
+                heading: "Basic configuration"
+            },
+            lookupFlag,
+            {
+                option: "config",
+                alias: "c",
+                type: "path::String",
+                description: usingFlatConfig
+                    ? "Use this configuration instead of eslint.config.js"
+                    : "Use this configuration, overriding .eslintrc.* config options if present"
+            },
+            envFlag,
+            extFlag,
+            {
+                option: "global",
+                type: "[String]",
+                description: "Define global variables"
+            },
+            {
+                option: "parser",
+                type: "String",
+                description: "Specify the parser to be used"
+            },
+            {
+                option: "parser-options",
+                type: "Object",
+                description: "Specify parser options"
+            },
+            resolvePluginsFlag,
+            {
+                heading: "Specify Rules and Plugins"
+            },
+            {
+                option: "plugin",
+                type: "[String]",
+                description: "Specify plugins"
+            },
+            {
+                option: "rule",
+                type: "Object",
+                description: "Specify rules"
+            },
+            rulesDirFlag,
+            {
+                heading: "Fix Problems"
+            },
+            {
+                option: "fix",
+                type: "Boolean",
+                default: false,
+                description: "Automatically fix problems"
+            },
+            {
+                option: "fix-dry-run",
+                type: "Boolean",
+                default: false,
+                description: "Automatically fix problems without saving the changes to the file system"
+            },
+            {
+                option: "fix-type",
+                type: "Array",
+                description: "Specify the types of fixes to apply (directive, problem, suggestion, layout)"
+            },
+            {
+                heading: "Ignore Files"
+            },
+            ignorePathFlag,
+            {
+                option: "ignore",
+                type: "Boolean",
+                default: "true",
+                description: "Disable use of ignore files and patterns"
+            },
+            {
+                option: "ignore-pattern",
+                type: "[String]",
+                description: "Pattern of files to ignore (in addition to those in .eslintignore)",
+                concatRepeatedArrays: [true, {
+                    oneValuePerFlag: true
+                }]
+            },
+            {
+                heading: "Use stdin"
+            },
+            {
+                option: "stdin",
+                type: "Boolean",
+                default: "false",
+                description: "Lint code provided on <STDIN>"
+            },
+            {
+                option: "stdin-filename",
+                type: "String",
+                description: "Specify filename to process STDIN as"
+            },
+            {
+                heading: "Handle Warnings"
+            },
+            {
+                option: "quiet",
+                type: "Boolean",
+                default: "false",
+                description: "Report errors only"
+            },
+            {
+                option: "max-warnings",
+                type: "Int",
+                default: "-1",
+                description: "Number of warnings to trigger nonzero exit code"
+            },
+            {
+                heading: "Output"
+            },
+            {
+                option: "output-file",
+                alias: "o",
+                type: "path::String",
+                description: "Specify file to write report to"
+            },
+            {
+                option: "format",
+                alias: "f",
+                type: "String",
+                default: "stylish",
+                description: "Use a specific output format"
+            },
+            {
+                option: "color",
+                type: "Boolean",
+                alias: "no-color",
+                description: "Force enabling/disabling of color"
+            },
+            {
+                heading: "Inline configuration comments"
+            },
+            {
+                option: "inline-config",
+                type: "Boolean",
+                default: "true",
+                description: "Prevent comments from changing config or rules"
+            },
+            {
+                option: "report-unused-disable-directives",
+                type: "Boolean",
+                default: void 0,
+                description: "Adds reported errors for unused eslint-disable directives"
+            },
+            {
+                heading: "Caching"
+            },
+            {
+                option: "cache",
+                type: "Boolean",
+                default: "false",
+                description: "Only check changed files"
+            },
+            {
+                option: "cache-file",
+                type: "path::String",
+                default: ".eslintcache",
+                description: "Path to the cache file. Deprecated: use --cache-location"
+            },
+            {
+                option: "cache-location",
+                type: "path::String",
+                description: "Path to the cache file or directory"
+            },
+            {
+                option: "cache-strategy",
+                dependsOn: ["cache"],
+                type: "String",
+                default: "metadata",
+                enum: ["metadata", "content"],
+                description: "Strategy to use for detecting changed files in the cache"
+            },
+            {
+                heading: "Miscellaneous"
+            },
+            {
+                option: "init",
+                type: "Boolean",
+                default: "false",
+                description: "Run config initialization wizard"
+            },
+            {
+                option: "env-info",
+                type: "Boolean",
+                default: "false",
+                description: "Output execution environment information"
+            },
+            {
+                option: "error-on-unmatched-pattern",
+                type: "Boolean",
+                default: "true",
+                description: "Prevent errors when pattern is unmatched"
+            },
+            {
+                option: "exit-on-fatal-error",
+                type: "Boolean",
+                default: "false",
+                description: "Exit with exit code 2 in case of fatal error"
+            },
+            {
+                option: "debug",
+                type: "Boolean",
+                default: false,
+                description: "Output debugging information"
+            },
+            {
+                option: "help",
+                alias: "h",
+                type: "Boolean",
+                description: "Show help"
+            },
+            {
+                option: "version",
+                alias: "v",
+                type: "Boolean",
+                description: "Output the version number"
+            },
+            {
+                option: "print-config",
+                type: "path::String",
+                description: "Print the configuration for the given file"
+            }
+        ].filter(value => !!value)
+    });
+};

package/lib/rule-tester/flat-rule-tester.js

@@ -4,7 +4,7 @@
  */
 "use strict";
 
-/* eslint-env mocha -- Mocha/Jest wrapper */
+/* globals describe, it -- Mocha globals */
 
 //------------------------------------------------------------------------------
 // Requirements
@@ -430,7 +430,7 @@ class FlatRuleTester {
         if (typeof this[DESCRIBE] === "function" || typeof this[IT] === "function") {
             throw new Error(
                 "Set `RuleTester.itOnly` to use `only` with a custom test framework.\n" +
-                "See https://eslint.org/docs/developer-guide/nodejs-api#customizing-ruletester for more."
+                "See https://eslint.org/docs/latest/integrate/nodejs-api#customizing-ruletester for more."
             );
         }
         if (typeof it === "function") {
@@ -619,15 +619,17 @@ class FlatRuleTester {
                 plugins: {
                     "rule-tester": {
                         rules: {
-                            "validate-ast"() {
-                                return {
-                                    Program(node) {
-                                        beforeAST = cloneDeeplyExcludesParent(node);
-                                    },
-                                    "Program:exit"(node) {
-                                        afterAST = node;
-                                    }
-                                };
+                            "validate-ast": {
+                                create() {
+                                    return {
+                                        Program(node) {
+                                            beforeAST = cloneDeeplyExcludesParent(node);
+                                        },
+                                        "Program:exit"(node) {
+                                            afterAST = node;
+                                        }
+                                    };
+                                }
                             }
                         }
                     }

package/lib/rule-tester/rule-tester.js

@@ -4,7 +4,7 @@
  */
 "use strict";
 
-/* eslint-env mocha -- Mocha wrapper */
+/* globals describe, it -- Mocha globals */
 
 /*
  * This is a wrapper around mocha to allow for DRY unittests for eslint
@@ -314,7 +314,7 @@ function emitLegacyRuleAPIWarning(ruleName) {
     if (!emitLegacyRuleAPIWarning[`warned-${ruleName}`]) {
         emitLegacyRuleAPIWarning[`warned-${ruleName}`] = true;
         process.emitWarning(
-            `"${ruleName}" rule is using the deprecated function-style format and will stop working in ESLint v9. Please use object-style format: https://eslint.org/docs/developer-guide/working-with-rules`,
+            `"${ruleName}" rule is using the deprecated function-style format and will stop working in ESLint v9. Please use object-style format: https://eslint.org/docs/latest/extend/custom-rules`,
             "DeprecationWarning"
         );
     }
@@ -329,7 +329,7 @@ function emitMissingSchemaWarning(ruleName) {
     if (!emitMissingSchemaWarning[`warned-${ruleName}`]) {
         emitMissingSchemaWarning[`warned-${ruleName}`] = true;
         process.emitWarning(
-            `"${ruleName}" rule has options but is missing the "meta.schema" property and will stop working in ESLint v9. Please add a schema: https://eslint.org/docs/developer-guide/working-with-rules#options-schemas`,
+            `"${ruleName}" rule has options but is missing the "meta.schema" property and will stop working in ESLint v9. Please add a schema: https://eslint.org/docs/latest/extend/custom-rules#options-schemas`,
             "DeprecationWarning"
         );
     }
@@ -493,7 +493,7 @@ class RuleTester {
         if (typeof this[DESCRIBE] === "function" || typeof this[IT] === "function") {
             throw new Error(
                 "Set `RuleTester.itOnly` to use `only` with a custom test framework.\n" +
-                "See https://eslint.org/docs/developer-guide/nodejs-api#customizing-ruletester for more."
+                "See https://eslint.org/docs/latest/integrate/nodejs-api#customizing-ruletester for more."
             );
         }
         if (typeof it === "function") {
@@ -632,14 +632,18 @@ class RuleTester {
              * The goal is to check whether or not AST was modified when
              * running the rule under test.
              */
-            linter.defineRule("rule-tester/validate-ast", () => ({
-                Program(node) {
-                    beforeAST = cloneDeeplyExcludesParent(node);
-                },
-                "Program:exit"(node) {
-                    afterAST = node;
+            linter.defineRule("rule-tester/validate-ast", {
+                create() {
+                    return {
+                        Program(node) {
+                            beforeAST = cloneDeeplyExcludesParent(node);
+                        },
+                        "Program:exit"(node) {
+                            afterAST = node;
+                        }
+                    };
                 }
-            }));
+            });
 
             if (typeof config.parser === "string") {
                 assert(path.isAbsolute(config.parser), "Parsers provided as strings to RuleTester must be absolute paths");