eslint 8.21.0 → 8.23.1

package/lib/options.js

@@ -63,261 +63,309 @@ 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 opinionator 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"
-        },
-        {
-            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: "Specifying rules and plugins"
+            },
+            {
+                option: "plugin",
+                type: "[String]",
+                description: "Specify plugins"
+            },
+            {
+                option: "rule",
+                type: "Object",
+                description: "Specify rules"
+            },
+            rulesDirFlag,
+            {
+                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"
+            },
+            {
+                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"
+            }
+        ].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

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

package/lib/rules/array-callback-return.js

@@ -125,7 +125,7 @@ function getArrayMethodName(node) {
         }
     }
 
-    /* istanbul ignore next: unreachable */
+    /* c8 ignore next */
     return null;
 }
 

package/lib/rules/global-require.js

@@ -28,10 +28,11 @@ function findReference(scope, node) {
     const references = scope.references.filter(reference => reference.identifier.range[0] === node.range[0] &&
             reference.identifier.range[1] === node.range[1]);
 
-    /* istanbul ignore else: correctly returns null */
     if (references.length === 1) {
         return references[0];
     }
+
+    /* c8 ignore next */
     return null;
 
 }

package/lib/rules/indent-legacy.js

@@ -18,8 +18,8 @@ const astUtils = require("./utils/ast-utils");
 //------------------------------------------------------------------------------
 // Rule Definition
 //------------------------------------------------------------------------------
-
-/* istanbul ignore next: this rule has known coverage issues, but it's deprecated and shouldn't be updated in the future anyway. */
+// this rule has known coverage issues, but it's deprecated and shouldn't be updated in the future anyway.
+/* c8 ignore next */
 /** @type {import('../shared/types').Rule} */
 module.exports = {
     meta: {
@@ -212,10 +212,10 @@ module.exports = {
             if (context.options[0] === "tab") {
                 indentSize = 1;
                 indentType = "tab";
-            } else /* istanbul ignore else : this will be caught by options validation */ if (typeof context.options[0] === "number") {
+            } else /* c8 ignore start */ if (typeof context.options[0] === "number") {
                 indentSize = context.options[0];
                 indentType = "space";
-            }
+            }/* c8 ignore stop */
 
             if (context.options[1]) {
                 const opts = context.options[1];