eslint 9.9.1 → 9.10.0

package/README.md

@@ -297,9 +297,9 @@ The following companies, organizations, and individuals support ESLint's ongoing
 <!--sponsorsstart-->
 <h3>Platinum Sponsors</h3>
 <p><a href="https://automattic.com"><img src="https://images.opencollective.com/automattic/d0ef3e1/logo.png" alt="Automattic" height="128"></a> <a href="https://www.airbnb.com/"><img src="https://images.opencollective.com/airbnb/d327d66/logo.png" alt="Airbnb" height="128"></a></p><h3>Gold Sponsors</h3>
-<p><a href="#"><img src="https://images.opencollective.com/guest-bf377e88/avatar.png" alt="Eli Schleifer" height="96"></a> <a href="https://opensource.siemens.com"><img src="https://avatars.githubusercontent.com/u/624020?v=4" alt="Siemens" height="96"></a></p><h3>Silver Sponsors</h3>
+<p><a href="https://trunk.io/"><img src="https://images.opencollective.com/trunkio/fb92d60/avatar.png" alt="trunk.io" height="96"></a> <a href="https://opensource.siemens.com"><img src="https://avatars.githubusercontent.com/u/624020?v=4" alt="Siemens" height="96"></a></p><h3>Silver Sponsors</h3>
 <p><a href="https://www.jetbrains.com/"><img src="https://images.opencollective.com/jetbrains/fe76f99/logo.png" alt="JetBrains" height="64"></a> <a href="https://liftoff.io/"><img src="https://images.opencollective.com/liftoff/5c4fa84/logo.png" alt="Liftoff" height="64"></a> <a href="https://americanexpress.io"><img src="https://avatars.githubusercontent.com/u/3853301?v=4" alt="American Express" height="64"></a> <a href="https://www.workleap.com"><img src="https://avatars.githubusercontent.com/u/53535748?u=d1e55d7661d724bf2281c1bfd33cb8f99fe2465f&v=4" alt="Workleap" height="64"></a></p><h3>Bronze Sponsors</h3>
-<p><a href="https://www.notion.so"><img src="https://images.opencollective.com/notion/bf3b117/logo.png" alt="notion" height="32"></a> <a href="https://www.crosswordsolver.org/anagram-solver/"><img src="https://images.opencollective.com/anagram-solver/2666271/logo.png" alt="Anagram Solver" height="32"></a> <a href="https://icons8.com/"><img src="https://images.opencollective.com/icons8/7fa1641/logo.png" alt="Icons8" height="32"></a> <a href="https://discord.com"><img src="https://images.opencollective.com/discordapp/f9645d9/logo.png" alt="Discord" height="32"></a> <a href="https://www.ignitionapp.com"><img src="https://avatars.githubusercontent.com/u/5753491?v=4" alt="Ignition" height="32"></a> <a href="https://nx.dev"><img src="https://avatars.githubusercontent.com/u/23692104?v=4" alt="Nx" height="32"></a> <a href="https://herocoders.com"><img src="https://avatars.githubusercontent.com/u/37549774?v=4" alt="HeroCoders" height="32"></a> <a href="https://usenextbase.com"><img src="https://avatars.githubusercontent.com/u/145838380?v=4" alt="Nextbase Starter Kit" height="32"></a></p>
+<p><a href="https://www.crosswordsolver.org/anagram-solver/"><img src="https://images.opencollective.com/anagram-solver/2666271/logo.png" alt="Anagram Solver" height="32"></a> <a href="https://icons8.com/"><img src="https://images.opencollective.com/icons8/7fa1641/logo.png" alt="Icons8" height="32"></a> <a href="https://discord.com"><img src="https://images.opencollective.com/discordapp/f9645d9/logo.png" alt="Discord" height="32"></a> <a href="https://www.ignitionapp.com"><img src="https://avatars.githubusercontent.com/u/5753491?v=4" alt="Ignition" height="32"></a> <a href="https://nx.dev"><img src="https://avatars.githubusercontent.com/u/23692104?v=4" alt="Nx" height="32"></a> <a href="https://herocoders.com"><img src="https://avatars.githubusercontent.com/u/37549774?v=4" alt="HeroCoders" height="32"></a> <a href="https://usenextbase.com"><img src="https://avatars.githubusercontent.com/u/145838380?v=4" alt="Nextbase Starter Kit" height="32"></a></p>
 <!--sponsorsend-->
 
 <!--techsponsorsstart-->

package/lib/config/config.js

@@ -0,0 +1,278 @@
+/**
+ * @fileoverview The `Config` class
+ * @author Nicholas C. Zakas
+ */
+
+"use strict";
+
+//-----------------------------------------------------------------------------
+// Requirements
+//-----------------------------------------------------------------------------
+
+const { RuleValidator } = require("./rule-validator");
+const { flatConfigSchema, hasMethod } = require("./flat-config-schema");
+const { ObjectSchema } = require("@eslint/config-array");
+
+//-----------------------------------------------------------------------------
+// Helpers
+//-----------------------------------------------------------------------------
+
+const ruleValidator = new RuleValidator();
+
+const severities = new Map([
+    [0, 0],
+    [1, 1],
+    [2, 2],
+    ["off", 0],
+    ["warn", 1],
+    ["error", 2]
+]);
+
+/**
+ * Splits a plugin identifier in the form a/b/c into two parts: a/b and c.
+ * @param {string} identifier The identifier to parse.
+ * @returns {{objectName: string, pluginName: string}} The parts of the plugin
+ *      name.
+ */
+function splitPluginIdentifier(identifier) {
+    const parts = identifier.split("/");
+
+    return {
+        objectName: parts.pop(),
+        pluginName: parts.join("/")
+    };
+}
+
+/**
+ * Returns the name of an object in the config by reading its `meta` key.
+ * @param {Object} object The object to check.
+ * @returns {string?} The name of the object if found or `null` if there
+ *      is no name.
+ */
+function getObjectId(object) {
+
+    // first check old-style name
+    let name = object.name;
+
+    if (!name) {
+
+        if (!object.meta) {
+            return null;
+        }
+
+        name = object.meta.name;
+
+        if (!name) {
+            return null;
+        }
+    }
+
+    // now check for old-style version
+    let version = object.version;
+
+    if (!version) {
+        version = object.meta && object.meta.version;
+    }
+
+    // if there's a version then append that
+    if (version) {
+        return `${name}@${version}`;
+    }
+
+    return name;
+}
+
+/**
+ * Converts a languageOptions object to a JSON representation.
+ * @param {Record<string, any>} languageOptions The options to create a JSON
+ *     representation of.
+ * @param {string} objectKey The key of the object being converted.
+ * @returns {Record<string, any>} The JSON representation of the languageOptions.
+ * @throws {TypeError} If a function is found in the languageOptions.
+ */
+function languageOptionsToJSON(languageOptions, objectKey = "languageOptions") {
+
+    const result = {};
+
+    for (const [key, value] of Object.entries(languageOptions)) {
+        if (value) {
+            if (typeof value === "object") {
+                const name = getObjectId(value);
+
+                if (name && hasMethod(value)) {
+                    result[key] = name;
+                } else {
+                    result[key] = languageOptionsToJSON(value, key);
+                }
+                continue;
+            }
+
+            if (typeof value === "function") {
+                throw new TypeError(`Cannot serialize key "${key}" in ${objectKey}: Function values are not supported.`);
+            }
+
+        }
+
+        result[key] = value;
+    }
+
+    return result;
+}
+
+/**
+ * Normalizes the rules configuration. Ensure that each rule config is
+ * an array and that the severity is a number. This function modifies the
+ * rulesConfig.
+ * @param {Record<string, any>} rulesConfig The rules configuration to normalize.
+ * @returns {void}
+ */
+function normalizeRulesConfig(rulesConfig) {
+
+    for (const [ruleId, ruleConfig] of Object.entries(rulesConfig)) {
+
+        // ensure rule config is an array
+        if (!Array.isArray(ruleConfig)) {
+            rulesConfig[ruleId] = [ruleConfig];
+        }
+
+        // normalize severity
+        rulesConfig[ruleId][0] = severities.get(rulesConfig[ruleId][0]);
+    }
+
+}
+
+
+//-----------------------------------------------------------------------------
+// Exports
+//-----------------------------------------------------------------------------
+
+/**
+ * Represents a normalized configuration object.
+ */
+class Config {
+
+    /**
+     * The name to use for the language when serializing to JSON.
+     * @type {string|undefined}
+     */
+    #languageName;
+
+    /**
+     * The name to use for the processor when serializing to JSON.
+     * @type {string|undefined}
+     */
+    #processorName;
+
+    /**
+     * Creates a new instance.
+     * @param {Object} config The configuration object.
+     */
+    constructor(config) {
+
+        const { plugins, language, languageOptions, processor, ...otherKeys } = config;
+
+        // Validate config object
+        const schema = new ObjectSchema(flatConfigSchema);
+
+        schema.validate(config);
+
+        // first, copy all the other keys over
+        Object.assign(this, otherKeys);
+
+        // ensure that a language is specified
+        if (!language) {
+            throw new TypeError("Key 'language' is required.");
+        }
+
+        // copy the rest over
+        this.plugins = plugins;
+        this.language = language;
+
+        if (languageOptions) {
+            this.languageOptions = languageOptions;
+        }
+
+        // Check language value
+        const { pluginName: languagePluginName, objectName: localLanguageName } = splitPluginIdentifier(language);
+
+        this.#languageName = language;
+
+        if (!plugins || !plugins[languagePluginName] || !plugins[languagePluginName].languages || !plugins[languagePluginName].languages[localLanguageName]) {
+            throw new TypeError(`Key "language": Could not find "${localLanguageName}" in plugin "${languagePluginName}".`);
+        }
+
+        this.language = plugins[languagePluginName].languages[localLanguageName];
+
+        // Validate language options
+        if (this.languageOptions) {
+            try {
+                this.language.validateLanguageOptions(this.languageOptions);
+            } catch (error) {
+                throw new TypeError(`Key "languageOptions": ${error.message}`, { cause: error });
+            }
+        }
+
+        // Check processor value
+        if (processor) {
+            this.processor = processor;
+
+            if (typeof processor === "string") {
+                const { pluginName, objectName: localProcessorName } = splitPluginIdentifier(processor);
+
+                this.#processorName = processor;
+
+                if (!plugins || !plugins[pluginName] || !plugins[pluginName].processors || !plugins[pluginName].processors[localProcessorName]) {
+                    throw new TypeError(`Key "processor": Could not find "${localProcessorName}" in plugin "${pluginName}".`);
+                }
+
+                this.processor = plugins[pluginName].processors[localProcessorName];
+            } else if (typeof processor === "object") {
+                this.#processorName = getObjectId(processor);
+                this.processor = processor;
+            } else {
+                throw new TypeError("Key 'processor' must be a string or an object.");
+            }
+        }
+
+        // Process the rules
+        if (this.rules) {
+            normalizeRulesConfig(this.rules);
+            ruleValidator.validate(this);
+        }
+    }
+
+    /**
+     * Converts the configuration to a JSON representation.
+     * @returns {Record<string, any>} The JSON representation of the configuration.
+     * @throws {Error} If the configuration cannot be serialized.
+     */
+    toJSON() {
+
+        if (this.processor && !this.#processorName) {
+            throw new Error("Could not serialize processor object (missing 'meta' object).");
+        }
+
+        if (!this.#languageName) {
+            throw new Error("Could not serialize language object (missing 'meta' object).");
+        }
+
+        return {
+            ...this,
+            plugins: Object.entries(this.plugins).map(([namespace, plugin]) => {
+
+                const pluginId = getObjectId(plugin);
+
+                if (!pluginId) {
+                    return namespace;
+                }
+
+                return `${namespace}:${pluginId}`;
+            }),
+            language: this.#languageName,
+            languageOptions: languageOptionsToJSON(this.languageOptions),
+            processor: this.#processorName
+        };
+    }
+}
+
+module.exports = { Config };

package/lib/config/flat-config-array.js

@@ -10,9 +10,9 @@
 //-----------------------------------------------------------------------------
 
 const { ConfigArray, ConfigArraySymbol } = require("@eslint/config-array");
-const { flatConfigSchema, hasMethod } = require("./flat-config-schema");
-const { RuleValidator } = require("./rule-validator");
+const { flatConfigSchema } = require("./flat-config-schema");
 const { defaultConfig } = require("./default-config");
+const { Config } = require("./config");
 
 //-----------------------------------------------------------------------------
 // Helpers
@@ -23,62 +23,6 @@ const { defaultConfig } = require("./default-config");
  */
 const META_FIELDS = new Set(["name"]);
 
-const ruleValidator = new RuleValidator();
-
-/**
- * Splits a plugin identifier in the form a/b/c into two parts: a/b and c.
- * @param {string} identifier The identifier to parse.
- * @returns {{objectName: string, pluginName: string}} The parts of the plugin
- *      name.
- */
-function splitPluginIdentifier(identifier) {
-    const parts = identifier.split("/");
-
-    return {
-        objectName: parts.pop(),
-        pluginName: parts.join("/")
-    };
-}
-
-/**
- * Returns the name of an object in the config by reading its `meta` key.
- * @param {Object} object The object to check.
- * @returns {string?} The name of the object if found or `null` if there
- *      is no name.
- */
-function getObjectId(object) {
-
-    // first check old-style name
-    let name = object.name;
-
-    if (!name) {
-
-        if (!object.meta) {
-            return null;
-        }
-
-        name = object.meta.name;
-
-        if (!name) {
-            return null;
-        }
-    }
-
-    // now check for old-style version
-    let version = object.version;
-
-    if (!version) {
-        version = object.meta && object.meta.version;
-    }
-
-    // if there's a version then append that
-    if (version) {
-        return `${name}@${version}`;
-    }
-
-    return name;
-}
-
 /**
  * Wraps a config error with details about where the error occurred.
  * @param {Error} error The original error.
@@ -123,42 +67,6 @@ function wrapConfigErrorWithDetails(error, originalLength, baseLength) {
     );
 }
 
-/**
- * Converts a languageOptions object to a JSON representation.
- * @param {Record<string, any>} languageOptions The options to create a JSON
- *     representation of.
- * @param {string} objectKey The key of the object being converted.
- * @returns {Record<string, any>} The JSON representation of the languageOptions.
- * @throws {TypeError} If a function is found in the languageOptions.
- */
-function languageOptionsToJSON(languageOptions, objectKey = "languageOptions") {
-
-    const result = {};
-
-    for (const [key, value] of Object.entries(languageOptions)) {
-        if (value) {
-            if (typeof value === "object") {
-                const name = getObjectId(value);
-
-                if (name && hasMethod(value)) {
-                    result[key] = name;
-                } else {
-                    result[key] = languageOptionsToJSON(value, key);
-                }
-                continue;
-            }
-
-            if (typeof value === "function") {
-                throw new TypeError(`Cannot serialize key "${key}" in ${objectKey}: Function values are not supported.`);
-            }
-
-        }
-
-        result[key] = value;
-    }
-
-    return result;
-}
 
 const originalBaseConfig = Symbol("originalBaseConfig");
 const originalLength = Symbol("originalLength");
@@ -305,116 +213,7 @@ class FlatConfigArray extends ConfigArray {
      * @throws {TypeError} If the config is invalid.
      */
     [ConfigArraySymbol.finalizeConfig](config) {
-
-        const { plugins, language, languageOptions, processor } = config;
-        let parserName, processorName, languageName;
-        let invalidParser = false,
-            invalidProcessor = false,
-            invalidLanguage = false;
-
-        // Check parser value
-        if (languageOptions && languageOptions.parser) {
-            const { parser } = languageOptions;
-
-            if (typeof parser === "object") {
-                parserName = getObjectId(parser);
-
-                if (!parserName) {
-                    invalidParser = true;
-                }
-
-            } else {
-                invalidParser = true;
-            }
-        }
-
-        // Check language value
-        if (language) {
-            if (typeof language === "string") {
-                const { pluginName, objectName: localLanguageName } = splitPluginIdentifier(language);
-
-                languageName = language;
-
-                if (!plugins || !plugins[pluginName] || !plugins[pluginName].languages || !plugins[pluginName].languages[localLanguageName]) {
-                    throw new TypeError(`Key "language": Could not find "${localLanguageName}" in plugin "${pluginName}".`);
-                }
-
-                config.language = plugins[pluginName].languages[localLanguageName];
-            } else {
-                invalidLanguage = true;
-            }
-
-            try {
-                config.language.validateLanguageOptions(config.languageOptions);
-            } catch (error) {
-                throw new TypeError(`Key "languageOptions": ${error.message}`, { cause: error });
-            }
-        }
-
-        // Check processor value
-        if (processor) {
-            if (typeof processor === "string") {
-                const { pluginName, objectName: localProcessorName } = splitPluginIdentifier(processor);
-
-                processorName = processor;
-
-                if (!plugins || !plugins[pluginName] || !plugins[pluginName].processors || !plugins[pluginName].processors[localProcessorName]) {
-                    throw new TypeError(`Key "processor": Could not find "${localProcessorName}" in plugin "${pluginName}".`);
-                }
-
-                config.processor = plugins[pluginName].processors[localProcessorName];
-            } else if (typeof processor === "object") {
-                processorName = getObjectId(processor);
-
-                if (!processorName) {
-                    invalidProcessor = true;
-                }
-
-            } else {
-                invalidProcessor = true;
-            }
-        }
-
-        ruleValidator.validate(config);
-
-        // apply special logic for serialization into JSON
-        /* eslint-disable object-shorthand -- shorthand would change "this" value */
-        Object.defineProperty(config, "toJSON", {
-            value: function() {
-
-                if (invalidParser) {
-                    throw new Error("Could not serialize parser object (missing 'meta' object).");
-                }
-
-                if (invalidProcessor) {
-                    throw new Error("Could not serialize processor object (missing 'meta' object).");
-                }
-
-                if (invalidLanguage) {
-                    throw new Error("Caching is not supported when language is an object.");
-                }
-
-                return {
-                    ...this,
-                    plugins: Object.entries(plugins).map(([namespace, plugin]) => {
-
-                        const pluginId = getObjectId(plugin);
-
-                        if (!pluginId) {
-                            return namespace;
-                        }
-
-                        return `${namespace}:${pluginId}`;
-                    }),
-                    language: languageName,
-                    languageOptions: languageOptionsToJSON(languageOptions),
-                    processor: processorName
-                };
-            }
-        });
-        /* eslint-enable object-shorthand -- ok to enable now */
-
-        return config;
+        return new Config(config);
     }
     /* eslint-enable class-methods-use-this -- Desired as instance method */