eslint 8.18.0 → 8.21.0

package/lib/eslint/index.js

@@ -1,7 +1,9 @@
 "use strict";
 
 const { ESLint } = require("./eslint");
+const { FlatESLint } = require("./flat-eslint");
 
 module.exports = {
-    ESLint
+    ESLint,
+    FlatESLint
 };

package/lib/linter/linter.js

@@ -1119,6 +1119,10 @@ function runRules(sourceCode, configuredRules, ruleMapper, parserName, languageO
             };
         }
 
+        if (typeof ruleListeners === "undefined" || ruleListeners === null) {
+            throw new Error(`The create() function for rule '${ruleId}' did not return an object.`);
+        }
+
         // add all the selectors from the rule as listeners
         Object.keys(ruleListeners).forEach(selector => {
             const ruleListener = timing.enabled
@@ -1506,7 +1510,31 @@ class Linter {
             options.filterCodeBlock ||
             (blockFilename => blockFilename.endsWith(".js"));
         const originalExtname = path.extname(filename);
-        const messageLists = preprocess(text, filenameToExpose).map((block, i) => {
+
+        let blocks;
+
+        try {
+            blocks = preprocess(text, filenameToExpose);
+        } catch (ex) {
+
+            // If the message includes a leading line number, strip it:
+            const message = `Preprocessing error: ${ex.message.replace(/^line \d+:/iu, "").trim()}`;
+
+            debug("%s\n%s", message, ex.stack);
+
+            return [
+                {
+                    ruleId: null,
+                    fatal: true,
+                    severity: 2,
+                    message,
+                    line: ex.lineNumber,
+                    column: ex.column
+                }
+            ];
+        }
+
+        const messageLists = blocks.map((block, i) => {
             debug("A code block was found: %o", block.filename || "(unnamed)");
 
             // Keep the legacy behavior.
@@ -1580,6 +1608,11 @@ class Linter {
             ...languageOptions.globals
         };
 
+        // double check that there is a parser to avoid mysterious error messages
+        if (!languageOptions.parser) {
+            throw new TypeError(`No parser specified for ${options.filename}`);
+        }
+
         // Espree expects this information to be passed in
         if (isEspree(languageOptions.parser)) {
             const parserOptions = languageOptions.parserOptions;
@@ -1742,12 +1775,24 @@ class Linter {
         debug("With flat config: %s", options.filename);
 
         // we need a filename to match configs against
-        const filename = options.filename || "<input>";
+        const filename = options.filename || "__placeholder__.js";
 
         // Store the config array in order to get plugin envs and rules later.
         internalSlotsMap.get(this).lastConfigArray = configArray;
         const config = configArray.getConfig(filename);
 
+        if (!config) {
+            return [
+                {
+                    ruleId: null,
+                    severity: 1,
+                    message: `No matching configuration found for ${filename}.`,
+                    line: 0,
+                    column: 0
+                }
+            ];
+        }
+
         // Verify.
         if (config.processor) {
             debug("Apply the processor: %o", config.processor);
@@ -1784,13 +1829,36 @@ class Linter {
         const physicalFilename = options.physicalFilename || filenameToExpose;
         const text = ensureText(textOrSourceCode);
         const preprocess = options.preprocess || (rawText => [rawText]);
-
         const postprocess = options.postprocess || (messagesList => messagesList.flat());
         const filterCodeBlock =
             options.filterCodeBlock ||
             (blockFilename => blockFilename.endsWith(".js"));
         const originalExtname = path.extname(filename);
-        const messageLists = preprocess(text, filenameToExpose).map((block, i) => {
+
+        let blocks;
+
+        try {
+            blocks = preprocess(text, filenameToExpose);
+        } catch (ex) {
+
+            // If the message includes a leading line number, strip it:
+            const message = `Preprocessing error: ${ex.message.replace(/^line \d+:/iu, "").trim()}`;
+
+            debug("%s\n%s", message, ex.stack);
+
+            return [
+                {
+                    ruleId: null,
+                    fatal: true,
+                    severity: 2,
+                    message,
+                    line: ex.lineNumber,
+                    column: ex.column
+                }
+            ];
+        }
+
+        const messageLists = blocks.map((block, i) => {
             debug("A code block was found: %o", block.filename || "(unnamed)");
 
             // Keep the legacy behavior.

package/lib/rule-tester/flat-rule-tester.js

@@ -480,51 +480,54 @@ class FlatRuleTester {
             ].concat(scenarioErrors).join("\n"));
         }
 
-        const baseConfig = {
-            plugins: {
-
-                // copy root plugin over
-                "@": {
-
-                    /*
-                     * Parsers are wrapped to detect more errors, so this needs
-                     * to be a new object for each call to run(), otherwise the
-                     * parsers will be wrapped multiple times.
-                     */
-                    parsers: {
-                        ...defaultConfig[0].plugins["@"].parsers
-                    },
+        const baseConfig = [
+            {
+                plugins: {
 
-                    /*
-                     * The rules key on the default plugin is a proxy to lazy-load
-                     * just the rules that are needed. So, don't create a new object
-                     * here, just use the default one to keep that performance
-                     * enhancement.
-                     */
-                    rules: defaultConfig[0].plugins["@"].rules
-                },
-                "rule-to-test": {
-                    rules: {
-                        [ruleName]: Object.assign({}, rule, {
+                    // copy root plugin over
+                    "@": {
+
+                        /*
+                         * Parsers are wrapped to detect more errors, so this needs
+                         * to be a new object for each call to run(), otherwise the
+                         * parsers will be wrapped multiple times.
+                         */
+                        parsers: {
+                            ...defaultConfig[0].plugins["@"].parsers
+                        },
+
+                        /*
+                         * The rules key on the default plugin is a proxy to lazy-load
+                         * just the rules that are needed. So, don't create a new object
+                         * here, just use the default one to keep that performance
+                         * enhancement.
+                         */
+                        rules: defaultConfig[0].plugins["@"].rules
+                    },
+                    "rule-to-test": {
+                        rules: {
+                            [ruleName]: Object.assign({}, rule, {
 
-                            // Create a wrapper rule that freezes the `context` properties.
-                            create(context) {
-                                freezeDeeply(context.options);
-                                freezeDeeply(context.settings);
-                                freezeDeeply(context.parserOptions);
+                                // Create a wrapper rule that freezes the `context` properties.
+                                create(context) {
+                                    freezeDeeply(context.options);
+                                    freezeDeeply(context.settings);
+                                    freezeDeeply(context.parserOptions);
 
-                                // freezeDeeply(context.languageOptions);
+                                    // freezeDeeply(context.languageOptions);
 
-                                return (typeof rule === "function" ? rule : rule.create)(context);
-                            }
-                        })
+                                    return (typeof rule === "function" ? rule : rule.create)(context);
+                                }
+                            })
+                        }
                     }
+                },
+                languageOptions: {
+                    ...defaultConfig[0].languageOptions
                 }
             },
-            languageOptions: {
-                ...defaultConfig[0].languageOptions
-            }
-        };
+            ...defaultConfig.slice(1)
+        ];
 
         /**
          * Run the rule for the given item

package/lib/rule-tester/rule-tester.js

@@ -305,6 +305,36 @@ function getCommentsDeprecation() {
     );
 }
 
+/**
+ * Emit a deprecation warning if function-style format is being used.
+ * @param {string} ruleName Name of the rule.
+ * @returns {void}
+ */
+function emitLegacyRuleAPIWarning(ruleName) {
+    if (!emitLegacyRuleAPIWarning[`warned-${ruleName}`]) {
+        emitLegacyRuleAPIWarning[`warned-${ruleName}`] = true;
+        process.emitWarning(
+            `"${ruleName}" rule is using the deprecated function-style format and will stop working in ESLint v9. Please use object-style format: https://eslint.org/docs/developer-guide/working-with-rules`,
+            "DeprecationWarning"
+        );
+    }
+}
+
+/**
+ * Emit a deprecation warning if rule has options but is missing the "meta.schema" property
+ * @param {string} ruleName Name of the rule.
+ * @returns {void}
+ */
+function emitMissingSchemaWarning(ruleName) {
+    if (!emitMissingSchemaWarning[`warned-${ruleName}`]) {
+        emitMissingSchemaWarning[`warned-${ruleName}`] = true;
+        process.emitWarning(
+            `"${ruleName}" rule has options but is missing the "meta.schema" property and will stop working in ESLint v9. Please add a schema: https://eslint.org/docs/developer-guide/working-with-rules#options-schemas`,
+            "DeprecationWarning"
+        );
+    }
+}
+
 //------------------------------------------------------------------------------
 // Public Interface
 //------------------------------------------------------------------------------
@@ -521,6 +551,9 @@ class RuleTester {
             ].concat(scenarioErrors).join("\n"));
         }
 
+        if (typeof rule === "function") {
+            emitLegacyRuleAPIWarning(ruleName);
+        }
 
         linter.defineRule(ruleName, Object.assign({}, rule, {
 
@@ -578,6 +611,15 @@ class RuleTester {
 
             if (hasOwnProperty(item, "options")) {
                 assert(Array.isArray(item.options), "options must be an array");
+                if (
+                    item.options.length > 0 &&
+                    typeof rule === "object" &&
+                    (
+                        !rule.meta || (rule.meta && (typeof rule.meta.schema === "undefined" || rule.meta.schema === null))
+                    )
+                ) {
+                    emitMissingSchemaWarning(ruleName);
+                }
                 config.rules[ruleName] = [1].concat(item.options);
             } else {
                 config.rules[ruleName] = 1;

package/lib/rules/accessor-pairs.js

@@ -140,7 +140,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "enforce getter and setter pairs in objects and classes",
+            description: "Enforce getter and setter pairs in objects and classes",
             recommended: false,
             url: "https://eslint.org/docs/rules/accessor-pairs"
         },

package/lib/rules/array-bracket-newline.js

@@ -17,7 +17,7 @@ module.exports = {
         type: "layout",
 
         docs: {
-            description: "enforce linebreaks after opening and before closing array brackets",
+            description: "Enforce linebreaks after opening and before closing array brackets",
             recommended: false,
             url: "https://eslint.org/docs/rules/array-bracket-newline"
         },

package/lib/rules/array-bracket-spacing.js

@@ -16,7 +16,7 @@ module.exports = {
         type: "layout",
 
         docs: {
-            description: "enforce consistent spacing inside array brackets",
+            description: "Enforce consistent spacing inside array brackets",
             recommended: false,
             url: "https://eslint.org/docs/rules/array-bracket-spacing"
         },

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

@@ -139,7 +139,7 @@ module.exports = {
         type: "problem",
 
         docs: {
-            description: "enforce `return` statements in callbacks of array methods",
+            description: "Enforce `return` statements in callbacks of array methods",
             recommended: false,
             url: "https://eslint.org/docs/rules/array-callback-return"
         },

package/lib/rules/array-element-newline.js

@@ -17,7 +17,7 @@ module.exports = {
         type: "layout",
 
         docs: {
-            description: "enforce line breaks after each array element",
+            description: "Enforce line breaks after each array element",
             recommended: false,
             url: "https://eslint.org/docs/rules/array-element-newline"
         },

package/lib/rules/arrow-body-style.js

@@ -20,7 +20,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "require braces around arrow function bodies",
+            description: "Require braces around arrow function bodies",
             recommended: false,
             url: "https://eslint.org/docs/rules/arrow-body-style"
         },

package/lib/rules/arrow-parens.js

@@ -33,7 +33,7 @@ module.exports = {
         type: "layout",
 
         docs: {
-            description: "require parentheses around arrow function arguments",
+            description: "Require parentheses around arrow function arguments",
             recommended: false,
             url: "https://eslint.org/docs/rules/arrow-parens"
         },

package/lib/rules/arrow-spacing.js

@@ -20,7 +20,7 @@ module.exports = {
         type: "layout",
 
         docs: {
-            description: "enforce consistent spacing before and after the arrow in arrow functions",
+            description: "Enforce consistent spacing before and after the arrow in arrow functions",
             recommended: false,
             url: "https://eslint.org/docs/rules/arrow-spacing"
         },

package/lib/rules/block-scoped-var.js

@@ -14,7 +14,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "enforce the use of variables within the scope they are defined",
+            description: "Enforce the use of variables within the scope they are defined",
             recommended: false,
             url: "https://eslint.org/docs/rules/block-scoped-var"
         },

package/lib/rules/block-spacing.js

@@ -17,7 +17,7 @@ module.exports = {
         type: "layout",
 
         docs: {
-            description: "disallow or enforce spaces inside of blocks after opening block and before closing block",
+            description: "Disallow or enforce spaces inside of blocks after opening block and before closing block",
             recommended: false,
             url: "https://eslint.org/docs/rules/block-spacing"
         },

package/lib/rules/brace-style.js

@@ -17,7 +17,7 @@ module.exports = {
         type: "layout",
 
         docs: {
-            description: "enforce consistent brace style for blocks",
+            description: "Enforce consistent brace style for blocks",
             recommended: false,
             url: "https://eslint.org/docs/rules/brace-style"
         },

package/lib/rules/callback-return.js

@@ -19,7 +19,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "require `return` statements after callbacks",
+            description: "Require `return` statements after callbacks",
             recommended: false,
             url: "https://eslint.org/docs/rules/callback-return"
         },

package/lib/rules/camelcase.js

@@ -21,7 +21,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "enforce camelcase naming convention",
+            description: "Enforce camelcase naming convention",
             recommended: false,
             url: "https://eslint.org/docs/rules/camelcase"
         },

package/lib/rules/capitalized-comments.js

@@ -105,7 +105,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "enforce or disallow capitalization of the first letter of a comment",
+            description: "Enforce or disallow capitalization of the first letter of a comment",
             recommended: false,
             url: "https://eslint.org/docs/rules/capitalized-comments"
         },

package/lib/rules/class-methods-use-this.js

@@ -21,7 +21,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "enforce that class methods utilize `this`",
+            description: "Enforce that class methods utilize `this`",
             recommended: false,
             url: "https://eslint.org/docs/rules/class-methods-use-this"
         },

package/lib/rules/comma-dangle.js

@@ -76,7 +76,7 @@ module.exports = {
         type: "layout",
 
         docs: {
-            description: "require or disallow trailing commas",
+            description: "Require or disallow trailing commas",
             recommended: false,
             url: "https://eslint.org/docs/rules/comma-dangle"
         },

package/lib/rules/comma-spacing.js

@@ -16,7 +16,7 @@ module.exports = {
         type: "layout",
 
         docs: {
-            description: "enforce consistent spacing before and after commas",
+            description: "Enforce consistent spacing before and after commas",
             recommended: false,
             url: "https://eslint.org/docs/rules/comma-spacing"
         },
@@ -103,38 +103,6 @@ module.exports = {
             });
         }
 
-        /**
-         * Validates the spacing around a comma token.
-         * @param {Object} tokens The tokens to be validated.
-         * @param {Token} tokens.comma The token representing the comma.
-         * @param {Token} [tokens.left] The last token before the comma.
-         * @param {Token} [tokens.right] The first token after the comma.
-         * @param {Token|ASTNode} reportItem The item to use when reporting an error.
-         * @returns {void}
-         * @private
-         */
-        function validateCommaItemSpacing(tokens, reportItem) {
-            if (tokens.left && astUtils.isTokenOnSameLine(tokens.left, tokens.comma) &&
-                    (options.before !== sourceCode.isSpaceBetweenTokens(tokens.left, tokens.comma))
-            ) {
-                report(reportItem, "before", tokens.left);
-            }
-
-            if (tokens.right && astUtils.isClosingParenToken(tokens.right)) {
-                return;
-            }
-
-            if (tokens.right && !options.after && tokens.right.type === "Line") {
-                return;
-            }
-
-            if (tokens.right && astUtils.isTokenOnSameLine(tokens.comma, tokens.right) &&
-                    (options.after !== sourceCode.isSpaceBetweenTokens(tokens.comma, tokens.right))
-            ) {
-                report(reportItem, "after", tokens.right);
-            }
-        }
-
         /**
          * Adds null elements of the given ArrayExpression or ArrayPattern node to the ignore list.
          * @param {ASTNode} node An ArrayExpression or ArrayPattern node.
@@ -172,18 +140,44 @@ module.exports = {
                         return;
                     }
 
-                    if (token && token.type === "JSXText") {
-                        return;
-                    }
-
                     const previousToken = tokensAndComments[i - 1];
                     const nextToken = tokensAndComments[i + 1];
 
-                    validateCommaItemSpacing({
-                        comma: token,
-                        left: astUtils.isCommaToken(previousToken) || commaTokensToIgnore.includes(token) ? null : previousToken,
-                        right: astUtils.isCommaToken(nextToken) ? null : nextToken
-                    }, token);
+                    if (
+                        previousToken &&
+                        !astUtils.isCommaToken(previousToken) && // ignore spacing between two commas
+
+                        /*
+                         * `commaTokensToIgnore` are ending commas of `null` elements (array holes/elisions).
+                         * In addition to spacing between two commas, this can also ignore:
+                         *
+                         *   - Spacing after `[` (controlled by array-bracket-spacing)
+                         *       Example: [ , ]
+                         *                 ^
+                         *   - Spacing after a comment (for backwards compatibility, this was possibly unintentional)
+                         *       Example: [a, /* * / ,]
+                         *                          ^
+                         */
+                        !commaTokensToIgnore.includes(token) &&
+
+                        astUtils.isTokenOnSameLine(previousToken, token) &&
+                        options.before !== sourceCode.isSpaceBetweenTokens(previousToken, token)
+                    ) {
+                        report(token, "before", previousToken);
+                    }
+
+                    if (
+                        nextToken &&
+                        !astUtils.isCommaToken(nextToken) && // ignore spacing between two commas
+                        !astUtils.isClosingParenToken(nextToken) && // controlled by space-in-parens
+                        !astUtils.isClosingBracketToken(nextToken) && // controlled by array-bracket-spacing
+                        !astUtils.isClosingBraceToken(nextToken) && // controlled by object-curly-spacing
+                        !(!options.after && nextToken.type === "Line") && // special case, allow space before line comment
+                        astUtils.isTokenOnSameLine(token, nextToken) &&
+                        options.after !== sourceCode.isSpaceBetweenTokens(token, nextToken)
+                    ) {
+                        report(token, "after", nextToken);
+                    }
                 });
             },
             ArrayExpression: addNullElementsToIgnoreList,

package/lib/rules/comma-style.js

@@ -17,7 +17,7 @@ module.exports = {
         type: "layout",
 
         docs: {
-            description: "enforce consistent comma style",
+            description: "Enforce consistent comma style",
             recommended: false,
             url: "https://eslint.org/docs/rules/comma-style"
         },

package/lib/rules/complexity.js

@@ -23,7 +23,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "enforce a maximum cyclomatic complexity allowed in a program",
+            description: "Enforce a maximum cyclomatic complexity allowed in a program",
             recommended: false,
             url: "https://eslint.org/docs/rules/complexity"
         },

package/lib/rules/computed-property-spacing.js

@@ -16,7 +16,7 @@ module.exports = {
         type: "layout",
 
         docs: {
-            description: "enforce consistent spacing inside computed property brackets",
+            description: "Enforce consistent spacing inside computed property brackets",
             recommended: false,
             url: "https://eslint.org/docs/rules/computed-property-spacing"
         },

package/lib/rules/consistent-return.js

@@ -46,7 +46,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "require `return` statements to either always or never specify values",
+            description: "Require `return` statements to either always or never specify values",
             recommended: false,
             url: "https://eslint.org/docs/rules/consistent-return"
         },

package/lib/rules/consistent-this.js

@@ -14,7 +14,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "enforce consistent naming when capturing the current execution context",
+            description: "Enforce consistent naming when capturing the current execution context",
             recommended: false,
             url: "https://eslint.org/docs/rules/consistent-this"
         },

package/lib/rules/constructor-super.js

@@ -122,7 +122,7 @@ module.exports = {
         type: "problem",
 
         docs: {
-            description: "require `super()` calls in constructors",
+            description: "Require `super()` calls in constructors",
             recommended: true,
             url: "https://eslint.org/docs/rules/constructor-super"
         },

package/lib/rules/curly.js

@@ -20,7 +20,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "enforce consistent brace style for all control statements",
+            description: "Enforce consistent brace style for all control statements",
             recommended: false,
             url: "https://eslint.org/docs/rules/curly"
         },

package/lib/rules/default-case-last.js

@@ -15,7 +15,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "enforce default clauses in switch statements to be last",
+            description: "Enforce default clauses in switch statements to be last",
             recommended: false,
             url: "https://eslint.org/docs/rules/default-case-last"
         },

package/lib/rules/default-case.js

@@ -16,7 +16,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "require `default` cases in `switch` statements",
+            description: "Require `default` cases in `switch` statements",
             recommended: false,
             url: "https://eslint.org/docs/rules/default-case"
         },