eslint 8.17.0 → 8.20.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
 ```
 
@@ -261,11 +255,6 @@ Brett Zamir
 Bryan Mishkin
 </a>
 </td><td align="center" valign="top" width="11%">
-<a href="https://github.com/mysticatea">
-<img src="https://github.com/mysticatea.png?s=75" width="75" height="75"><br />
-Toru Nagashima
-</a>
-</td><td align="center" valign="top" width="11%">
 <a href="https://github.com/SaraSoueidan">
 <img src="https://github.com/SaraSoueidan.png?s=75" width="75" height="75"><br />
 Sara Soueidan
@@ -297,7 +286,7 @@ 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="undefined"></a></p><h3>Gold Sponsors</h3>
-<p><a href="https://www.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> <a href="https://americanexpress.io"><img src="https://avatars.githubusercontent.com/u/3853301?v=4" alt="American Express" height="96"></a> <a href="https://substack.com/"><img src="https://avatars.githubusercontent.com/u/53023767?v=4" alt="Substack" height="96"></a></p><h3>Silver Sponsors</h3>
+<p><a href="https://www.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> <a href="https://americanexpress.io"><img src="https://avatars.githubusercontent.com/u/3853301?v=4" alt="American Express" height="96"></a></p><h3>Silver Sponsors</h3>
 <p><a href="https://liftoff.io/"><img src="https://images.opencollective.com/liftoff/5c4fa84/logo.png" alt="Liftoff" height="64"></a></p><h3>Bronze Sponsors</h3>
 <p><a href="https://launchdarkly.com"><img src="https://images.opencollective.com/launchdarkly/574bb9e/logo.png" alt="launchdarkly" height="32"></a> <a href="https://nx.dev"><img src="https://images.opencollective.com/nx/0efbe42/logo.png" alt="Nx (by Nrwl)" 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://www.vpsserver.com"><img src="https://images.opencollective.com/vpsservercom/logo.png" alt="VPS" height="32"></a> <a href="https://icons8.com"><img src="https://images.opencollective.com/icons8/7fa1641/logo.png" alt="Icons8: free icons, photos, illustrations, and music" 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://themeisle.com"><img src="https://images.opencollective.com/themeisle/d5592fe/logo.png" alt="ThemeIsle" 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://herocoders.com"><img src="https://avatars.githubusercontent.com/u/37549774?v=4" alt="HeroCoders" height="32"></a></p>
 <!--sponsorsend-->

package/lib/linter/linter.js

@@ -1101,7 +1101,7 @@ function runRules(sourceCode, configuredRules, ruleMapper, parserName, languageO
             )
         );
 
-        const ruleListeners = createRuleListeners(rule, ruleContext);
+        const ruleListeners = timing.enabled ? timing.time(ruleId, createRuleListeners)(rule, ruleContext) : createRuleListeners(rule, ruleContext);
 
         /**
          * Include `ruleId` in error logs
@@ -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.
@@ -1784,13 +1812,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/linter/timing.js

@@ -138,10 +138,11 @@ module.exports = (function() {
 
         return function(...args) {
             let t = process.hrtime();
+            const result = fn(...args);
 
-            fn(...args);
             t = process.hrtime(t);
             data[key] += t[0] * 1e3 + t[1] / 1e6;
+            return result;
         };
     }
 

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"
         },

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

@@ -11,7 +11,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "enforce default parameters to be last",
+            description: "Enforce default parameters to be last",
             recommended: false,
             url: "https://eslint.org/docs/rules/default-param-last"
         },

package/lib/rules/dot-location.js

@@ -17,7 +17,7 @@ module.exports = {
         type: "layout",
 
         docs: {
-            description: "enforce consistent newlines before and after dots",
+            description: "Enforce consistent newlines before and after dots",
             recommended: false,
             url: "https://eslint.org/docs/rules/dot-location"
         },

package/lib/rules/dot-notation.js

@@ -26,7 +26,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "enforce dot notation whenever possible",
+            description: "Enforce dot notation whenever possible",
             recommended: false,
             url: "https://eslint.org/docs/rules/dot-notation"
         },

package/lib/rules/eol-last.js

@@ -14,7 +14,7 @@ module.exports = {
         type: "layout",
 
         docs: {
-            description: "require or disallow newline at the end of files",
+            description: "Require or disallow newline at the end of files",
             recommended: false,
             url: "https://eslint.org/docs/rules/eol-last"
         },

package/lib/rules/eqeqeq.js

@@ -21,7 +21,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "require the use of `===` and `!==`",
+            description: "Require the use of `===` and `!==`",
             recommended: false,
             url: "https://eslint.org/docs/rules/eqeqeq"
         },

package/lib/rules/for-direction.js

@@ -15,7 +15,7 @@ module.exports = {
         type: "problem",
 
         docs: {
-            description: "enforce \"for\" loop update clause moving the counter in the right direction.",
+            description: "Enforce \"for\" loop update clause moving the counter in the right direction.",
             recommended: true,
             url: "https://eslint.org/docs/rules/for-direction"
         },

package/lib/rules/func-call-spacing.js

@@ -21,7 +21,7 @@ module.exports = {
         type: "layout",
 
         docs: {
-            description: "require or disallow spacing between function identifiers and their invocations",
+            description: "Require or disallow spacing between function identifiers and their invocations",
             recommended: false,
             url: "https://eslint.org/docs/rules/func-call-spacing"
         },

package/lib/rules/func-name-matching.js

@@ -74,7 +74,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "require function names to match the name of the variable or property to which they are assigned",
+            description: "Require function names to match the name of the variable or property to which they are assigned",
             recommended: false,
             url: "https://eslint.org/docs/rules/func-name-matching"
         },

package/lib/rules/func-names.js

@@ -30,7 +30,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "require or disallow named `function` expressions",
+            description: "Require or disallow named `function` expressions",
             recommended: false,
             url: "https://eslint.org/docs/rules/func-names"
         },

package/lib/rules/func-style.js

@@ -14,7 +14,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "enforce the consistent use of either `function` declarations or expressions",
+            description: "Enforce the consistent use of either `function` declarations or expressions",
             recommended: false,
             url: "https://eslint.org/docs/rules/func-style"
         },

package/lib/rules/function-call-argument-newline.js

@@ -15,7 +15,7 @@ module.exports = {
         type: "layout",
 
         docs: {
-            description: "enforce line breaks between arguments of a function call",
+            description: "Enforce line breaks between arguments of a function call",
             recommended: false,
             url: "https://eslint.org/docs/rules/function-call-argument-newline"
         },

package/lib/rules/function-paren-newline.js

@@ -20,7 +20,7 @@ module.exports = {
         type: "layout",
 
         docs: {
-            description: "enforce consistent line breaks inside function parentheses",
+            description: "Enforce consistent line breaks inside function parentheses",
             recommended: false,
             url: "https://eslint.org/docs/rules/function-paren-newline"
         },