eslint 8.56.0 → 9.0.0-alpha.0

package/lib/linter/apply-disable-directives.js

@@ -16,6 +16,11 @@
 //------------------------------------------------------------------------------
 
 const escapeRegExp = require("escape-string-regexp");
+const {
+    Legacy: {
+        ConfigOps
+    }
+} = require("@eslint/eslintrc/universal");
 
 /**
  * Compares the locations of two objects in a source file
@@ -345,11 +350,11 @@ function applyDirectives(options) {
     }
 
     const unusedDisableDirectivesToReport = options.directives
-        .filter(directive => directive.type === "disable" && !usedDisableDirectives.has(directive));
+        .filter(directive => directive.type === "disable" && !usedDisableDirectives.has(directive) && !options.rulesToIgnore.has(directive.ruleId));
 
 
     const unusedEnableDirectivesToReport = new Set(
-        options.directives.filter(directive => directive.unprocessedDirective.type === "enable")
+        options.directives.filter(directive => directive.unprocessedDirective.type === "enable" && !options.rulesToIgnore.has(directive.ruleId))
     );
 
     /*
@@ -410,11 +415,13 @@ function applyDirectives(options) {
  * @param {{ruleId: (string|null), line: number, column: number}[]} options.problems
  * A list of problems reported by rules, sorted by increasing location in the file, with one-based columns.
  * @param {"off" | "warn" | "error"} options.reportUnusedDisableDirectives If `"warn"` or `"error"`, adds additional problems for unused directives
+ * @param {Object} options.configuredRules The rules configuration.
+ * @param {Function} options.ruleFilter A predicate function to filter which rules should be executed.
  * @param {boolean} options.disableFixes If true, it doesn't make `fix` properties.
  * @returns {{ruleId: (string|null), line: number, column: number, suppressions?: {kind: string, justification: string}}[]}
  * An object with a list of reported problems, the suppressed of which contain the suppression information.
  */
-module.exports = ({ directives, disableFixes, problems, reportUnusedDisableDirectives = "off" }) => {
+module.exports = ({ directives, disableFixes, problems, configuredRules, ruleFilter, reportUnusedDisableDirectives = "off" }) => {
     const blockDirectives = directives
         .filter(directive => directive.type === "disable" || directive.type === "enable")
         .map(directive => Object.assign({}, directive, { unprocessedDirective: directive }))
@@ -443,17 +450,38 @@ module.exports = ({ directives, disableFixes, problems, reportUnusedDisableDirec
         }
     }).sort(compareLocations);
 
+    // This determines a list of rules that are not being run by the given ruleFilter, if present.
+    const rulesToIgnore = configuredRules && ruleFilter
+        ? new Set(Object.keys(configuredRules).filter(ruleId => {
+            const severity = ConfigOps.getRuleSeverity(configuredRules[ruleId]);
+
+            // Ignore for disabled rules.
+            if (severity === 0) {
+                return false;
+            }
+
+            return !ruleFilter({ severity, ruleId });
+        }))
+        : new Set();
+
+    // If no ruleId is supplied that means this directive is applied to all rules, so we can't determine if it's unused if any rules are filtered out.
+    if (rulesToIgnore.size > 0) {
+        rulesToIgnore.add(null);
+    }
+
     const blockDirectivesResult = applyDirectives({
         problems,
         directives: blockDirectives,
         disableFixes,
-        reportUnusedDisableDirectives
+        reportUnusedDisableDirectives,
+        rulesToIgnore
     });
     const lineDirectivesResult = applyDirectives({
         problems: blockDirectivesResult.problems,
         directives: lineDirectives,
         disableFixes,
-        reportUnusedDisableDirectives
+        reportUnusedDisableDirectives,
+        rulesToIgnore
     });
 
     return reportUnusedDisableDirectives !== "off"

package/lib/linter/config-comment-parser.js

@@ -40,7 +40,7 @@ module.exports = class ConfigCommentParser {
 
     /**
      * Parses a list of "name:string_value" or/and "name" options divided by comma or
-     * whitespace. Used for "global" and "exported" comments.
+     * whitespace. Used for "global" comments.
      * @param {string} string The string to parse.
      * @param {Comment} comment The comment node which has the string.
      * @returns {Object} Result map object of names and string values, or null values if no value was provided

package/lib/linter/linter.js

@@ -105,6 +105,7 @@ const parserSymbol = Symbol.for("eslint.RuleTester.parser");
  * @property {string} [filename] the filename of the source code.
  * @property {boolean | "off" | "warn" | "error"} [reportUnusedDisableDirectives] Adds reported errors for
  *      unused `eslint-disable` directives.
+ * @property {Function} [ruleFilter] A predicate function that determines whether a given rule should run.
  */
 
 /**
@@ -392,7 +393,7 @@ function getDirectiveComments(sourceCode, ruleMapper, warnInlineConfig) {
             }
 
             case "exported":
-                Object.assign(exportedVariables, commentParser.parseStringConfig(directiveValue, comment));
+                Object.assign(exportedVariables, commentParser.parseListConfig(directiveValue, comment));
                 break;
 
             case "globals":
@@ -439,6 +440,15 @@ function getDirectiveComments(sourceCode, ruleMapper, warnInlineConfig) {
                         try {
                             validator.validateRuleOptions(rule, name, ruleValue);
                         } catch (err) {
+
+                            /*
+                             * If the rule has invalid `meta.schema`, throw the error because
+                             * this is not an invalid inline configuration but an invalid rule.
+                             */
+                            if (err.code === "ESLINT_INVALID_RULE_OPTIONS_SCHEMA") {
+                                throw err;
+                            }
+
                             problems.push(createLintingProblem({
                                 ruleId: name,
                                 message: err.message,
@@ -661,6 +671,12 @@ function normalizeVerifyOptions(providedOptions, config) {
         }
     }
 
+    let ruleFilter = providedOptions.ruleFilter;
+
+    if (typeof ruleFilter !== "function") {
+        ruleFilter = () => true;
+    }
+
     return {
         filename: normalizeFilename(providedOptions.filename || "<input>"),
         allowInlineConfig: !ignoreInlineConfig,
@@ -668,7 +684,8 @@ function normalizeVerifyOptions(providedOptions, config) {
             ? `your config${configNameOfNoInlineConfig}`
             : null,
         reportUnusedDisableDirectives,
-        disableFixes: Boolean(providedOptions.disableFixes)
+        disableFixes: Boolean(providedOptions.disableFixes),
+        ruleFilter
     };
 }
 
@@ -885,12 +902,18 @@ function parse(text, languageOptions, filePath) {
 
 /**
  * Runs a rule, and gets its listeners
- * @param {Rule} rule A normalized rule with a `create` method
+ * @param {Rule} rule A rule object
  * @param {Context} ruleContext The context that should be passed to the rule
+ * @throws {TypeError} If `rule` is not an object with a `create` method
  * @throws {any} Any error during the rule's `create`
  * @returns {Object} A map of selector listeners provided by the rule
  */
 function createRuleListeners(rule, ruleContext) {
+
+    if (!rule || typeof rule !== "object" || typeof rule.create !== "function") {
+        throw new TypeError(`Error while loading rule '${ruleContext.id}': Rule must be an object with a \`create\` method`);
+    }
+
     try {
         return rule.create(ruleContext);
     } catch (ex) {
@@ -899,43 +922,6 @@ function createRuleListeners(rule, ruleContext) {
     }
 }
 
-// methods that exist on SourceCode object
-const DEPRECATED_SOURCECODE_PASSTHROUGHS = {
-    getSource: "getText",
-    getSourceLines: "getLines",
-    getAllComments: "getAllComments",
-    getNodeByRangeIndex: "getNodeByRangeIndex",
-    getComments: "getComments",
-    getCommentsBefore: "getCommentsBefore",
-    getCommentsAfter: "getCommentsAfter",
-    getCommentsInside: "getCommentsInside",
-    getJSDocComment: "getJSDocComment",
-    getFirstToken: "getFirstToken",
-    getFirstTokens: "getFirstTokens",
-    getLastToken: "getLastToken",
-    getLastTokens: "getLastTokens",
-    getTokenAfter: "getTokenAfter",
-    getTokenBefore: "getTokenBefore",
-    getTokenByRangeStart: "getTokenByRangeStart",
-    getTokens: "getTokens",
-    getTokensAfter: "getTokensAfter",
-    getTokensBefore: "getTokensBefore",
-    getTokensBetween: "getTokensBetween"
-};
-
-
-const BASE_TRAVERSAL_CONTEXT = Object.freeze(
-    Object.keys(DEPRECATED_SOURCECODE_PASSTHROUGHS).reduce(
-        (contextInfo, methodName) =>
-            Object.assign(contextInfo, {
-                [methodName](...args) {
-                    return this.sourceCode[DEPRECATED_SOURCECODE_PASSTHROUGHS[methodName]](...args);
-                }
-            }),
-        {}
-    )
-);
-
 /**
  * Runs the given rules on the given SourceCode object
  * @param {SourceCode} sourceCode A SourceCode object for the given text
@@ -948,9 +934,10 @@ const BASE_TRAVERSAL_CONTEXT = Object.freeze(
  * @param {boolean} disableFixes If true, it doesn't make `fix` properties.
  * @param {string | undefined} cwd cwd of the cli
  * @param {string} physicalFilename The full path of the file on disk without any code block information
+ * @param {Function} ruleFilter A predicate function to filter which rules should be executed.
  * @returns {LintMessage[]} An array of reported problems
  */
-function runRules(sourceCode, configuredRules, ruleMapper, parserName, languageOptions, settings, filename, disableFixes, cwd, physicalFilename) {
+function runRules(sourceCode, configuredRules, ruleMapper, parserName, languageOptions, settings, filename, disableFixes, cwd, physicalFilename, ruleFilter) {
     const emitter = createEmitter();
     const nodeQueue = [];
     let currentNode = sourceCode.ast;
@@ -972,30 +959,22 @@ function runRules(sourceCode, configuredRules, ruleMapper, parserName, languageO
      * properties once for each rule.
      */
     const sharedTraversalContext = Object.freeze(
-        Object.assign(
-            Object.create(BASE_TRAVERSAL_CONTEXT),
-            {
-                getAncestors: () => sourceCode.getAncestors(currentNode),
-                getDeclaredVariables: node => sourceCode.getDeclaredVariables(node),
-                getCwd: () => cwd,
-                cwd,
-                getFilename: () => filename,
-                filename,
-                getPhysicalFilename: () => physicalFilename || filename,
-                physicalFilename: physicalFilename || filename,
-                getScope: () => sourceCode.getScope(currentNode),
-                getSourceCode: () => sourceCode,
-                sourceCode,
-                markVariableAsUsed: name => sourceCode.markVariableAsUsed(name, currentNode),
-                parserOptions: {
-                    ...languageOptions.parserOptions
-                },
-                parserPath: parserName,
-                languageOptions,
-                parserServices: sourceCode.parserServices,
-                settings
-            }
-        )
+        {
+            getCwd: () => cwd,
+            cwd,
+            getFilename: () => filename,
+            filename,
+            getPhysicalFilename: () => physicalFilename || filename,
+            physicalFilename: physicalFilename || filename,
+            getSourceCode: () => sourceCode,
+            sourceCode,
+            parserOptions: {
+                ...languageOptions.parserOptions
+            },
+            parserPath: parserName,
+            languageOptions,
+            settings
+        }
     );
 
     const lintingProblems = [];
@@ -1008,6 +987,10 @@ function runRules(sourceCode, configuredRules, ruleMapper, parserName, languageO
             return;
         }
 
+        if (ruleFilter && !ruleFilter({ ruleId, severity })) {
+            return;
+        }
+
         const rule = ruleMapper(ruleId);
 
         if (!rule) {
@@ -1217,9 +1200,9 @@ class Linter {
      * Initialize the Linter.
      * @param {Object} [config] the config object
      * @param {string} [config.cwd] path to a directory that should be considered as the current working directory, can be undefined.
-     * @param {"flat"|"eslintrc"} [config.configType="eslintrc"] the type of config used.
+     * @param {"flat"|"eslintrc"} [config.configType="flat"] the type of config used.
      */
-    constructor({ cwd, configType } = {}) {
+    constructor({ cwd, configType = "flat" } = {}) {
         internalSlotsMap.set(this, {
             cwd: normalizeCwd(cwd),
             lastConfigArray: null,
@@ -1362,7 +1345,8 @@ class Linter {
                 options.filename,
                 options.disableFixes,
                 slots.cwd,
-                providedOptions.physicalFilename
+                providedOptions.physicalFilename,
+                null
             );
         } catch (err) {
             err.message += `\nOccurred while linting ${options.filename}`;
@@ -1413,29 +1397,29 @@ class Linter {
             ? { filename: filenameOrOptions }
             : filenameOrOptions || {};
 
-        if (config) {
-            if (configType === "flat") {
-
-                /*
-                 * Because of how Webpack packages up the files, we can't
-                 * compare directly to `FlatConfigArray` using `instanceof`
-                 * because it's not the same `FlatConfigArray` as in the tests.
-                 * So, we work around it by assuming an array is, in fact, a
-                 * `FlatConfigArray` if it has a `getConfig()` method.
-                 */
-                let configArray = config;
-
-                if (!Array.isArray(config) || typeof config.getConfig !== "function") {
-                    configArray = new FlatConfigArray(config, { basePath: cwd });
-                    configArray.normalizeSync();
-                }
+        const configToUse = config ?? {};
 
-                return this._distinguishSuppressedMessages(this._verifyWithFlatConfigArray(textOrSourceCode, configArray, options, true));
-            }
+        if (configType !== "eslintrc") {
+
+            /*
+             * Because of how Webpack packages up the files, we can't
+             * compare directly to `FlatConfigArray` using `instanceof`
+             * because it's not the same `FlatConfigArray` as in the tests.
+             * So, we work around it by assuming an array is, in fact, a
+             * `FlatConfigArray` if it has a `getConfig()` method.
+             */
+            let configArray = configToUse;
 
-            if (typeof config.extractConfig === "function") {
-                return this._distinguishSuppressedMessages(this._verifyWithConfigArray(textOrSourceCode, config, options));
+            if (!Array.isArray(configToUse) || typeof configToUse.getConfig !== "function") {
+                configArray = new FlatConfigArray(configToUse, { basePath: cwd });
+                configArray.normalizeSync();
             }
+
+            return this._distinguishSuppressedMessages(this._verifyWithFlatConfigArray(textOrSourceCode, configArray, options, true));
+        }
+
+        if (typeof configToUse.extractConfig === "function") {
+            return this._distinguishSuppressedMessages(this._verifyWithConfigArray(textOrSourceCode, configToUse, options));
         }
 
         /*
@@ -1448,9 +1432,9 @@ class Linter {
          * So we cannot apply multiple processors.
          */
         if (options.preprocess || options.postprocess) {
-            return this._distinguishSuppressedMessages(this._verifyWithProcessor(textOrSourceCode, config, options));
+            return this._distinguishSuppressedMessages(this._verifyWithProcessor(textOrSourceCode, configToUse, options));
         }
-        return this._distinguishSuppressedMessages(this._verifyWithoutProcessors(textOrSourceCode, config, options));
+        return this._distinguishSuppressedMessages(this._verifyWithoutProcessors(textOrSourceCode, configToUse, options));
     }
 
     /**
@@ -1693,6 +1677,14 @@ class Linter {
                             mergedInlineConfig.rules[ruleId] = ruleValue;
                         } catch (err) {
 
+                            /*
+                             * If the rule has invalid `meta.schema`, throw the error because
+                             * this is not an invalid inline configuration but an invalid rule.
+                             */
+                            if (err.code === "ESLINT_INVALID_RULE_OPTIONS_SCHEMA") {
+                                throw err;
+                            }
+
                             let baseMessage = err.message.slice(
                                 err.message.startsWith("Key \"rules\":")
                                     ? err.message.indexOf(":", 12) + 1
@@ -1737,7 +1729,8 @@ class Linter {
                 options.filename,
                 options.disableFixes,
                 slots.cwd,
-                providedOptions.physicalFilename
+                providedOptions.physicalFilename,
+                options.ruleFilter
             );
         } catch (err) {
             err.message += `\nOccurred while linting ${options.filename}`;
@@ -1768,7 +1761,9 @@ class Linter {
                 .concat(commentDirectives.problems)
                 .concat(inlineConfigProblems)
                 .sort((problemA, problemB) => problemA.line - problemB.line || problemA.column - problemB.column),
-            reportUnusedDisableDirectives: options.reportUnusedDisableDirectives
+            reportUnusedDisableDirectives: options.reportUnusedDisableDirectives,
+            ruleFilter: options.ruleFilter,
+            configuredRules
         });
     }
 
@@ -1986,17 +1981,17 @@ class Linter {
     /**
      * Defines a new linting rule.
      * @param {string} ruleId A unique rule identifier
-     * @param {Function | Rule} ruleModule Function from context to object mapping AST node types to event handlers
+     * @param {Rule} rule A rule object
      * @returns {void}
      */
-    defineRule(ruleId, ruleModule) {
+    defineRule(ruleId, rule) {
         assertEslintrcConfig(this);
-        internalSlotsMap.get(this).ruleMap.define(ruleId, ruleModule);
+        internalSlotsMap.get(this).ruleMap.define(ruleId, rule);
     }
 
     /**
      * Defines many new linting rules.
-     * @param {Record<string, Function | Rule>} rulesToDefine map from unique rule identifier to rule
+     * @param {Record<string, Rule>} rulesToDefine map from unique rule identifier to rule
      * @returns {void}
      */
     defineRules(rulesToDefine) {

package/lib/linter/rules.js

@@ -13,18 +13,10 @@
 const builtInRules = require("../rules");
 
 //------------------------------------------------------------------------------
-// Helpers
+// Typedefs
 //------------------------------------------------------------------------------
 
-/**
- * Normalizes a rule module to the new-style API
- * @param {(Function|{create: Function})} rule A rule object, which can either be a function
- * ("old-style") or an object with a `create` method ("new-style")
- * @returns {{create: Function}} A new-style rule.
- */
-function normalizeRule(rule) {
-    return typeof rule === "function" ? Object.assign({ create: rule }, rule) : rule;
-}
+/** @typedef {import("../shared/types").Rule} Rule */
 
 //------------------------------------------------------------------------------
 // Public Interface
@@ -41,18 +33,17 @@ class Rules {
     /**
      * Registers a rule module for rule id in storage.
      * @param {string} ruleId Rule id (file name).
-     * @param {Function} ruleModule Rule handler.
+     * @param {Rule} rule Rule object.
      * @returns {void}
      */
-    define(ruleId, ruleModule) {
-        this._rules[ruleId] = normalizeRule(ruleModule);
+    define(ruleId, rule) {
+        this._rules[ruleId] = rule;
     }
 
     /**
      * Access rule handler by id (file name).
      * @param {string} ruleId Rule id (file name).
-     * @returns {{create: Function, schema: JsonSchema[]}}
-     * A rule. This is normalized to always have the new-style shape with a `create` method.
+     * @returns {Rule} Rule object.
      */
     get(ruleId) {
         if (typeof this._rules[ruleId] === "string") {

package/lib/options.js

@@ -57,6 +57,8 @@ const optionator = require("optionator");
  * @property {boolean} quiet Report errors only
  * @property {boolean} [version] Output the version number
  * @property {boolean} warnIgnored Show warnings when the file list includes ignored files
+ * @property {boolean} [passOnNoPatterns=false] When set to true, missing patterns cause
+ *      the linting operation to short circuit and not report any failures.
  * @property {string[]} _ Positional filenames or patterns
  */
 
@@ -168,7 +170,7 @@ module.exports = function(usingFlatConfig) {
                 alias: "c",
                 type: "path::String",
                 description: usingFlatConfig
-                    ? "Use this configuration instead of eslint.config.js"
+                    ? "Use this configuration instead of eslint.config.js, eslint.config.mjs, or eslint.config.cjs"
                     : "Use this configuration, overriding .eslintrc.* config options if present"
             },
             envFlag,
@@ -370,6 +372,12 @@ module.exports = function(usingFlatConfig) {
                 description: "Exit with exit code 2 in case of fatal error"
             },
             warnIgnoredFlag,
+            {
+                option: "pass-on-no-patterns",
+                type: "Boolean",
+                default: false,
+                description: "Exit with exit code 0 in case no file patterns are passed"
+            },
             {
                 option: "debug",
                 type: "Boolean",