eslint 9.3.0 → 9.5.0

package/README.md

@@ -289,13 +289,13 @@ Percy Ma
 
 ## Sponsors
 
-The following companies, organizations, and individuals support ESLint's ongoing maintenance and development. [Become a Sponsor](https://opencollective.com/eslint) to get your logo on our README and website.
+The following companies, organizations, and individuals support ESLint's ongoing maintenance and development. [Become a Sponsor](https://eslint.org/donate) to get your logo on our README and website.
 
 <!-- NOTE: This section is autogenerated. Do not manually edit.-->
 <!--sponsorsstart-->
 <h3>Platinum Sponsors</h3>
 <p><a href="https://automattic.com"><img src="https://images.opencollective.com/automattic/d0ef3e1/logo.png" alt="Automattic" height="undefined"></a></p><h3>Gold Sponsors</h3>
-<p><a href="https://engineering.salesforce.com"><img src="https://images.opencollective.com/salesforce/ca8f997/logo.png" alt="Salesforce" height="96"></a> <a href="https://www.airbnb.com/"><img src="https://images.opencollective.com/airbnb/d327d66/logo.png" alt="Airbnb" height="96"></a></p><h3>Silver Sponsors</h3>
+<p><a href="#"><img src="https://images.opencollective.com/guest-bf377e88/avatar.png" alt="Eli Schleifer" height="96"></a> <a href="https://engineering.salesforce.com"><img src="https://images.opencollective.com/salesforce/ca8f997/logo.png" alt="Salesforce" height="96"></a> <a href="https://www.airbnb.com/"><img src="https://images.opencollective.com/airbnb/d327d66/logo.png" alt="Airbnb" 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>
 <!--sponsorsend-->

package/lib/api.js

@@ -13,7 +13,7 @@ const { ESLint, shouldUseFlatConfig } = require("./eslint/eslint");
 const { LegacyESLint } = require("./eslint/legacy-eslint");
 const { Linter } = require("./linter");
 const { RuleTester } = require("./rule-tester");
-const { SourceCode } = require("./source-code");
+const { SourceCode } = require("./languages/js/source-code");
 
 //-----------------------------------------------------------------------------
 // Functions

package/lib/cli.js

@@ -448,14 +448,14 @@ const cli = {
 
         if (options.inspectConfig) {
 
-            log.info("You can also run this command directly using 'npx @eslint/config-inspector' in the same directory as your configuration file.");
+            log.info("You can also run this command directly using 'npx @eslint/config-inspector@latest' in the same directory as your configuration file.");
 
             try {
                 const flatOptions = await translateOptions(options, "flat");
                 const spawn = require("cross-spawn");
                 const flags = await cli.calculateInspectConfigFlags(flatOptions.overrideConfigFile);
 
-                spawn.sync("npx", ["@eslint/config-inspector", ...flags], { encoding: "utf8", stdio: "inherit" });
+                spawn.sync("npx", ["@eslint/config-inspector@latest", ...flags], { encoding: "utf8", stdio: "inherit" });
             } catch (error) {
                 log.error(error);
                 return 2;

package/lib/config/default-config.js

@@ -20,6 +20,10 @@ exports.defaultConfig = [
         plugins: {
             "@": {
 
+                languages: {
+                    js: require("../languages/js")
+                },
+
                 /*
                  * Because we try to delay loading rules until absolutely
                  * necessary, a proxy allows us to hook into the lazy-loading
@@ -37,6 +41,7 @@ exports.defaultConfig = [
                 })
             }
         },
+        language: "@/js",
         languageOptions: {
             sourceType: "module",
             ecmaVersion: "latest",

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

@@ -9,8 +9,8 @@
 // Requirements
 //-----------------------------------------------------------------------------
 
-const { ConfigArray, ConfigArraySymbol } = require("@humanwhocodes/config-array");
-const { flatConfigSchema } = require("./flat-config-schema");
+const { ConfigArray, ConfigArraySymbol } = require("@eslint/config-array");
+const { flatConfigSchema, hasMethod } = require("./flat-config-schema");
 const { RuleValidator } = require("./rule-validator");
 const { defaultConfig } = require("./default-config");
 
@@ -123,6 +123,43 @@ 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");
 const baseLength = Symbol("baseLength");
@@ -269,10 +306,11 @@ class FlatConfigArray extends ConfigArray {
      */
     [ConfigArraySymbol.finalizeConfig](config) {
 
-        const { plugins, languageOptions, processor } = config;
-        let parserName, processorName;
+        const { plugins, language, languageOptions, processor } = config;
+        let parserName, processorName, languageName;
         let invalidParser = false,
-            invalidProcessor = false;
+            invalidProcessor = false,
+            invalidLanguage = false;
 
         // Check parser value
         if (languageOptions && languageOptions.parser) {
@@ -290,6 +328,29 @@ class FlatConfigArray extends ConfigArray {
             }
         }
 
+        // 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") {
@@ -329,6 +390,10 @@ class FlatConfigArray extends ConfigArray {
                     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]) => {
@@ -341,10 +406,8 @@ class FlatConfigArray extends ConfigArray {
 
                         return `${namespace}:${pluginId}`;
                     }),
-                    languageOptions: {
-                        ...languageOptions,
-                        parser: parserName
-                    },
+                    language: languageName,
+                    languageOptions: languageOptionsToJSON(languageOptions),
                     processor: processorName
                 };
             }

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

@@ -33,12 +33,6 @@ const ruleSeverities = new Map([
     [2, 2], ["error", 2]
 ]);
 
-const globalVariablesValues = new Set([
-    true, "true", "writable", "writeable",
-    false, "false", "readonly", "readable", null,
-    "off"
-]);
-
 /**
  * Check if a value is a non-null object.
  * @param {any} value The value to check.
@@ -143,6 +137,23 @@ function normalizeRuleOptions(ruleOptions) {
     return structuredClone(finalOptions);
 }
 
+/**
+ * Determines if an object has any methods.
+ * @param {Object} object The object to check.
+ * @returns {boolean} `true` if the object has any methods.
+ */
+function hasMethod(object) {
+
+    for (const key of Object.keys(object)) {
+
+        if (typeof object[key] === "function") {
+            return true;
+        }
+    }
+
+    return false;
+}
+
 //-----------------------------------------------------------------------------
 // Assertions
 //-----------------------------------------------------------------------------
@@ -301,47 +312,48 @@ const deepObjectAssignSchema = {
     validate: "object"
 };
 
+
 //-----------------------------------------------------------------------------
 // High-Level Schemas
 //-----------------------------------------------------------------------------
 
 /** @type {ObjectPropertySchema} */
-const globalsSchema = {
-    merge: "assign",
-    validate(value) {
+const languageOptionsSchema = {
+    merge(first = {}, second = {}) {
 
-        assertIsObject(value);
+        const result = deepMerge(first, second);
 
-        for (const key of Object.keys(value)) {
+        for (const [key, value] of Object.entries(result)) {
 
-            // avoid hairy edge case
-            if (key === "__proto__") {
-                continue;
-            }
+            /*
+             * Special case: Because the `parser` property is an object, it should
+             * not be deep merged. Instead, it should be replaced if it exists in
+             * the second object. To make this more generic, we just check for
+             * objects with methods and replace them if they exist in the second
+             * object.
+             */
+            if (isNonArrayObject(value)) {
+                if (hasMethod(value)) {
+                    result[key] = second[key] ?? first[key];
+                    continue;
+                }
 
-            if (key !== key.trim()) {
-                throw new TypeError(`Global "${key}" has leading or trailing whitespace.`);
+                // for other objects, make sure we aren't reusing the same object
+                result[key] = { ...result[key] };
+                continue;
             }
 
-            if (!globalVariablesValues.has(value[key])) {
-                throw new TypeError(`Key "${key}": Expected "readonly", "writable", or "off".`);
-            }
         }
-    }
+
+        return result;
+    },
+    validate: "object"
 };
 
 /** @type {ObjectPropertySchema} */
-const parserSchema = {
+const languageSchema = {
     merge: "replace",
-    validate(value) {
-
-        if (!value || typeof value !== "object" ||
-            (typeof value.parse !== "function" && typeof value.parseForESLint !== "function")
-        ) {
-            throw new TypeError("Expected object with parse() or parseForESLint() method.");
-        }
-
-    }
+    validate: assertIsPluginMemberName
 };
 
 /** @type {ObjectPropertySchema} */
@@ -501,28 +513,6 @@ const rulesSchema = {
     }
 };
 
-/** @type {ObjectPropertySchema} */
-const ecmaVersionSchema = {
-    merge: "replace",
-    validate(value) {
-        if (typeof value === "number" || value === "latest") {
-            return;
-        }
-
-        throw new TypeError("Expected a number or \"latest\".");
-    }
-};
-
-/** @type {ObjectPropertySchema} */
-const sourceTypeSchema = {
-    merge: "replace",
-    validate(value) {
-        if (typeof value !== "string" || !/^(?:script|module|commonjs)$/u.test(value)) {
-            throw new TypeError("Expected \"script\", \"module\", or \"commonjs\".");
-        }
-    }
-};
-
 /**
  * Creates a schema that always throws an error. Useful for warning
  * about eslintrc-style keys.
@@ -568,15 +558,8 @@ const flatConfigSchema = {
             reportUnusedDisableDirectives: disableDirectiveSeveritySchema
         }
     },
-    languageOptions: {
-        schema: {
-            ecmaVersion: ecmaVersionSchema,
-            sourceType: sourceTypeSchema,
-            globals: globalsSchema,
-            parser: parserSchema,
-            parserOptions: deepObjectAssignSchema
-        }
-    },
+    language: languageSchema,
+    languageOptions: languageOptionsSchema,
     processor: processorSchema,
     plugins: pluginsSchema,
     rules: rulesSchema
@@ -588,5 +571,6 @@ const flatConfigSchema = {
 
 module.exports = {
     flatConfigSchema,
+    hasMethod,
     assertIsRuleSeverity
 };

package/lib/eslint/eslint-helpers.js

@@ -91,7 +91,7 @@ class AllFilesIgnoredError extends Error {
      */
     constructor(pattern) {
         super(`All files matched by '${pattern}' are ignored.`);
-        this.messageTemplate = "all-files-ignored";
+        this.messageTemplate = "all-matched-files-ignored";
         this.messageData = { pattern };
     }
 }
@@ -335,15 +335,15 @@ async function globSearch({
 
                             /*
                              * We updated the unmatched patterns set only if the path
-                             * matches and the file isn't ignored. If the file is
-                             * ignored, that means there wasn't a match for the
+                             * matches and the file has a config. If the file has no
+                             * config, that means there wasn't a match for the
                              * pattern so it should not be removed.
                              *
-                             * Performance note: isFileIgnored() aggressively caches
+                             * Performance note: `getConfig()` aggressively caches
                              * results so there is no performance penalty for calling
-                             * it twice with the same argument.
+                             * it multiple times with the same argument.
                              */
-                            if (pathMatches && !configs.isFileIgnored(entry.path)) {
+                            if (pathMatches && configs.getConfig(entry.path)) {
                                 unmatchedPatterns.delete(matcher.pattern);
                             }
 
@@ -351,7 +351,7 @@ async function globSearch({
                         }, false)
                         : matchers.some(matcher => matcher.match(relativePath));
 
-                    return matchesPattern && !configs.isFileIgnored(entry.path);
+                    return matchesPattern && configs.getConfig(entry.path) !== void 0;
                 })
             },
             (error, entries) => {
@@ -494,7 +494,7 @@ async function globMultiSearch({ searches, configs, errorOnUnmatchedPattern }) {
 
     }
 
-    return [...new Set(filePaths)];
+    return filePaths;
 
 }
 
@@ -543,10 +543,7 @@ async function findFiles({
 
             // files are added directly to the list
             if (stat.isFile()) {
-                results.push({
-                    filePath,
-                    ignored: configs.isFileIgnored(filePath)
-                });
+                results.push(filePath);
             }
 
             // directories need extensions attached
@@ -604,11 +601,10 @@ async function findFiles({
     });
 
     return [
-        ...results,
-        ...globbyResults.map(filePath => ({
-            filePath: path.resolve(filePath),
-            ignored: false
-        }))
+        ...new Set([
+            ...results,
+            ...globbyResults.map(filePath => path.resolve(filePath))
+        ])
     ];
 }
 
@@ -630,17 +626,31 @@ function isErrorMessage(message) {
  * Returns result with warning by ignore settings
  * @param {string} filePath File path of checked code
  * @param {string} baseDir Absolute path of base directory
+ * @param {"ignored"|"external"|"unconfigured"} configStatus A status that determines why the file is ignored
  * @returns {LintResult} Result with single warning
  * @private
  */
-function createIgnoreResult(filePath, baseDir) {
+function createIgnoreResult(filePath, baseDir, configStatus) {
     let message;
-    const isInNodeModules = baseDir && path.dirname(path.relative(baseDir, filePath)).split(path.sep).includes("node_modules");
 
-    if (isInNodeModules) {
-        message = "File ignored by default because it is located under the node_modules directory. Use ignore pattern \"!**/node_modules/\" to disable file ignore settings or use \"--no-warn-ignored\" to suppress this warning.";
-    } else {
-        message = "File ignored because of a matching ignore pattern. Use \"--no-ignore\" to disable file ignore settings or use \"--no-warn-ignored\" to suppress this warning.";
+    switch (configStatus) {
+        case "external":
+            message = "File ignored because outside of base path.";
+            break;
+        case "unconfigured":
+            message = "File ignored because no matching configuration was supplied.";
+            break;
+        default:
+            {
+                const isInNodeModules = baseDir && path.dirname(path.relative(baseDir, filePath)).split(path.sep).includes("node_modules");
+
+                if (isInNodeModules) {
+                    message = "File ignored by default because it is located under the node_modules directory. Use ignore pattern \"!**/node_modules/\" to disable file ignore settings or use \"--no-warn-ignored\" to suppress this warning.";
+                } else {
+                    message = "File ignored because of a matching ignore pattern. Use \"--no-ignore\" to disable file ignore settings or use \"--no-warn-ignored\" to suppress this warning.";
+                }
+            }
+            break;
     }
 
     return {

package/lib/eslint/eslint.js

@@ -68,7 +68,7 @@ const { Retrier } = require("@humanwhocodes/retry");
  * The options with which to configure the ESLint instance.
  * @typedef {Object} ESLintOptions
  * @property {boolean} [allowInlineConfig] Enable or disable inline configuration comments.
- * @property {ConfigData} [baseConfig] Base config object, extended by all configs used with this instance
+ * @property {ConfigData|Array<ConfigData>} [baseConfig] Base config, extended by all configs used with this instance
  * @property {boolean} [cache] Enable result caching.
  * @property {string} [cacheLocation] The cache file to use instead of .eslintcache.
  * @property {"metadata" | "content"} [cacheStrategy] The strategy used to detect changed files.
@@ -79,7 +79,7 @@ const { Retrier } = require("@humanwhocodes/retry");
  * @property {boolean} [globInputPaths] Set to false to skip glob resolution of input file paths to lint (default: true). If false, each input file paths is assumed to be a non-glob path to an existing file.
  * @property {boolean} [ignore] False disables all ignore patterns except for the default ones.
  * @property {string[]} [ignorePatterns] Ignore file patterns to use in addition to config ignores. These patterns are relative to `cwd`.
- * @property {ConfigData} [overrideConfig] Override config object, overrides all configs used with this instance
+ * @property {ConfigData|Array<ConfigData>} [overrideConfig] Override config, overrides all configs used with this instance
  * @property {boolean|string} [overrideConfigFile] Searches for default config file when falsy;
  *      doesn't do any config file lookup when `true`; considered to be a config filename
  *      when a string.
@@ -509,7 +509,7 @@ function verifyText({
              * @returns {boolean} `true` if the linter should adopt the code block.
              */
             filterCodeBlock(blockFilename) {
-                return configs.isExplicitMatch(blockFilename);
+                return configs.getConfig(blockFilename) !== void 0;
             }
         }
     );
@@ -865,28 +865,21 @@ class ESLint {
          */
         const results = await Promise.all(
 
-            filePaths.map(({ filePath, ignored }) => {
-
-                /*
-                 * If a filename was entered that matches an ignore
-                 * pattern, then notify the user.
-                 */
-                if (ignored) {
-                    if (warnIgnored) {
-                        return createIgnoreResult(filePath, cwd);
-                    }
-
-                    return void 0;
-                }
+            filePaths.map(filePath => {
 
                 const config = configs.getConfig(filePath);
 
                 /*
-                 * Sometimes a file found through a glob pattern will
-                 * be ignored. In this case, `config` will be undefined
-                 * and we just silently ignore the file.
+                 * If a filename was entered that cannot be matched
+                 * to a config, then notify the user.
                  */
                 if (!config) {
+                    if (warnIgnored) {
+                        const configStatus = configs.getConfigStatus(filePath);
+
+                        return createIgnoreResult(filePath, cwd, configStatus);
+                    }
+
                     return void 0;
                 }
 
@@ -1038,7 +1031,9 @@ class ESLint {
             const shouldWarnIgnored = typeof warnIgnored === "boolean" ? warnIgnored : constructorWarnIgnored;
 
             if (shouldWarnIgnored) {
-                results.push(createIgnoreResult(resolvedFilename, cwd));
+                const configStatus = configs.getConfigStatus(resolvedFilename);
+
+                results.push(createIgnoreResult(resolvedFilename, cwd, configStatus));
             }
         } else {