eslint 8.19.0 → 8.22.0

package/README.md

@@ -45,21 +45,15 @@ ESLint is a tool for identifying and reporting on patterns found in ECMAScript/J
 
 Prerequisites: [Node.js](https://nodejs.org/) (`^12.22.0`, `^14.17.0`, or `>=16.0.0`) built with SSL support. (If you are using an official Node.js distribution, SSL is always built in.)
 
-You can install ESLint using npm:
+You can install and configure ESLint using this command:
 
-```sh
-npm install eslint --save-dev
-```
-
-You should then set up a configuration file:
-
-```sh
+```shell
 npm init @eslint/config
 ```
 
 After that, you can run ESLint on any file or directory like this:
 
-```sh
+```shell
 ./node_modules/.bin/eslint yourfile.js
 ```
 

package/lib/config/default-config.js

@@ -15,7 +15,6 @@ const Rules = require("../rules");
 // Helpers
 //-----------------------------------------------------------------------------
 
-
 exports.defaultConfig = [
     {
         plugins: {
@@ -41,21 +40,31 @@ exports.defaultConfig = [
                 })
             }
         },
-        ignores: [
-            "**/node_modules/**",
-            ".git/**"
-        ],
         languageOptions: {
-            ecmaVersion: "latest",
             sourceType: "module",
+            ecmaVersion: "latest",
             parser: "@/espree",
             parserOptions: {}
         }
     },
+
+    // default ignores are listed here
+    {
+        ignores: [
+            "**/node_modules/**",
+            ".git/**"
+        ]
+    },
+
+    // intentionally empty config to ensure these files are globbed by default
+    {
+        files: ["**/*.js", "**/*.mjs"]
+    },
     {
         files: ["**/*.cjs"],
         languageOptions: {
-            sourceType: "commonjs"
+            sourceType: "commonjs",
+            ecmaVersion: "latest"
         }
     }
 ];

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

@@ -36,6 +36,8 @@ function splitPluginIdentifier(identifier) {
     };
 }
 
+const originalBaseConfig = Symbol("originalBaseConfig");
+
 //-----------------------------------------------------------------------------
 // Exports
 //-----------------------------------------------------------------------------
@@ -48,10 +50,14 @@ class FlatConfigArray extends ConfigArray {
     /**
      * Creates a new instance.
      * @param {*[]} configs An array of configuration information.
-     * @param {{basePath: string, baseConfig: FlatConfig}} options The options
+     * @param {{basePath: string, shouldIgnore: boolean, baseConfig: FlatConfig}} options The options
      *      to use for the config array instance.
      */
-    constructor(configs, { basePath, baseConfig = defaultConfig } = {}) {
+    constructor(configs, {
+        basePath,
+        shouldIgnore = true,
+        baseConfig = defaultConfig
+    } = {}) {
         super(configs, {
             basePath,
             schema: flatConfigSchema
@@ -62,6 +68,22 @@ class FlatConfigArray extends ConfigArray {
         } else {
             this.unshift(baseConfig);
         }
+
+        /**
+         * The baes config used to build the config array.
+         * @type {Array<FlatConfig>}
+         */
+        this[originalBaseConfig] = baseConfig;
+        Object.defineProperty(this, originalBaseConfig, { writable: false });
+
+        /**
+         * Determines if `ignores` fields should be honored.
+         * If true, then all `ignores` fields are honored.
+         * if false, then only `ignores` fields in the baseConfig are honored.
+         * @type {boolean}
+         */
+        this.shouldIgnore = shouldIgnore;
+        Object.defineProperty(this, "shouldIgnore", { writable: false });
     }
 
     /* eslint-disable class-methods-use-this -- Desired as instance method */
@@ -87,6 +109,23 @@ class FlatConfigArray extends ConfigArray {
             return require("../../conf/eslint-all");
         }
 
+        /*
+         * If `shouldIgnore` is false, we remove any ignore patterns specified
+         * in the config so long as it's not a default config and it doesn't
+         * have a `files` entry.
+         */
+        if (
+            !this.shouldIgnore &&
+            !this[originalBaseConfig].includes(config) &&
+            config.ignores &&
+            !config.files
+        ) {
+            /* eslint-disable-next-line no-unused-vars -- need to strip off other keys */
+            const { ignores, ...otherKeys } = config;
+
+            return otherKeys;
+        }
+
         return config;
     }
 
@@ -100,31 +139,72 @@ class FlatConfigArray extends ConfigArray {
     [ConfigArraySymbol.finalizeConfig](config) {
 
         const { plugins, languageOptions, processor } = config;
+        let parserName, processorName;
+        let invalidParser = false,
+            invalidProcessor = false;
 
         // Check parser value
-        if (languageOptions && languageOptions.parser && typeof languageOptions.parser === "string") {
-            const { pluginName, objectName: parserName } = splitPluginIdentifier(languageOptions.parser);
+        if (languageOptions && languageOptions.parser) {
+            if (typeof languageOptions.parser === "string") {
+                const { pluginName, objectName: localParserName } = splitPluginIdentifier(languageOptions.parser);
 
-            if (!plugins || !plugins[pluginName] || !plugins[pluginName].parsers || !plugins[pluginName].parsers[parserName]) {
-                throw new TypeError(`Key "parser": Could not find "${parserName}" in plugin "${pluginName}".`);
-            }
+                parserName = languageOptions.parser;
+
+                if (!plugins || !plugins[pluginName] || !plugins[pluginName].parsers || !plugins[pluginName].parsers[localParserName]) {
+                    throw new TypeError(`Key "parser": Could not find "${localParserName}" in plugin "${pluginName}".`);
+                }
 
-            languageOptions.parser = plugins[pluginName].parsers[parserName];
+                languageOptions.parser = plugins[pluginName].parsers[localParserName];
+            } else {
+                invalidParser = true;
+            }
         }
 
         // Check processor value
-        if (processor && typeof processor === "string") {
-            const { pluginName, objectName: processorName } = splitPluginIdentifier(processor);
+        if (processor) {
+            if (typeof processor === "string") {
+                const { pluginName, objectName: localProcessorName } = splitPluginIdentifier(processor);
 
-            if (!plugins || !plugins[pluginName] || !plugins[pluginName].processors || !plugins[pluginName].processors[processorName]) {
-                throw new TypeError(`Key "processor": Could not find "${processorName}" in plugin "${pluginName}".`);
-            }
+                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[processorName];
+                config.processor = plugins[pluginName].processors[localProcessorName];
+            } 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("Caching is not supported when parser is an object.");
+                }
+
+                if (invalidProcessor) {
+                    throw new Error("Caching is not supported when processor is an object.");
+                }
+
+                return {
+                    ...this,
+                    plugins: Object.keys(plugins),
+                    languageOptions: {
+                        ...languageOptions,
+                        parser: parserName
+                    },
+                    processor: processorName
+                };
+            }
+        });
+        /* eslint-enable object-shorthand -- ok to enable now */
+
         return config;
     }
     /* eslint-enable class-methods-use-this -- Desired as instance method */

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

@@ -20,7 +20,14 @@ function parseRuleId(ruleId) {
 
     // distinguish between core rules and plugin rules
     if (ruleId.includes("/")) {
-        pluginName = ruleId.slice(0, ruleId.lastIndexOf("/"));
+
+        // mimic scoped npm packages
+        if (ruleId.startsWith("@")) {
+            pluginName = ruleId.slice(0, ruleId.lastIndexOf("/"));
+        } else {
+            pluginName = ruleId.slice(0, ruleId.indexOf("/"));
+        }
+
         ruleName = ruleId.slice(pluginName.length + 1);
     } else {
         pluginName = "@";
@@ -47,6 +54,7 @@ function getRuleFromConfig(ruleId, config) {
     const plugin = config.plugins && config.plugins[pluginName];
     let rule = plugin && plugin.rules && plugin.rules[ruleName];
 
+
     // normalize function rules into objects
     if (rule && typeof rule === "function") {
         rule = {