eslint 8.28.0 → 8.30.0

package/lib/cli-engine/formatters/formatters-meta.json

@@ -0,0 +1,46 @@
+[
+    {
+        "name": "checkstyle",
+        "description": "Outputs results to the [Checkstyle](https://checkstyle.sourceforge.io/) format."
+    },
+    {
+        "name": "compact",
+        "description": "Human-readable output format. Mimics the default output of JSHint."
+    },
+    {
+        "name": "html",
+        "description": "Outputs results to HTML. The `html` formatter is useful for visual presentation in the browser."
+    },
+    {
+        "name": "jslint-xml",
+        "description": "Outputs results to format compatible with the [JSLint Jenkins plugin](https://plugins.jenkins.io/jslint/)."
+    },
+    {
+        "name": "json-with-metadata",
+        "description": "Outputs JSON-serialized results. The `json-with-metadata` provides the same linting results as the [`json`](#json) formatter with additional metadata about the rules applied. The linting results are included in the `results` property and the rules metadata is included in the `metadata` property.\n\nAlternatively, you can use the [ESLint Node.js API](../../developer-guide/nodejs-api) to programmatically use ESLint."
+    },
+    {
+        "name": "json",
+        "description": "Outputs JSON-serialized results. The `json` formatter is useful when you want to programmatically work with the CLI's linting results.\n\nAlternatively, you can use the [ESLint Node.js API](../../developer-guide/nodejs-api) to programmatically use ESLint."
+    },
+    {
+        "name": "junit",
+        "description": "Outputs results to format compatible with the [JUnit Jenkins plugin](https://plugins.jenkins.io/junit/)."
+    },
+    {
+        "name": "stylish",
+        "description": "Human-readable output format. This is the default formatter."
+    },
+    {
+        "name": "tap",
+        "description": "Outputs results to the [Test Anything Protocol (TAP)](https://testanything.org/) specification format."
+    },
+    {
+        "name": "unix",
+        "description": "Outputs results to a format similar to many commands in UNIX-like systems. Parsable with tools such as [grep](https://www.gnu.org/software/grep/manual/grep.html), [sed](https://www.gnu.org/software/sed/manual/sed.html), and [awk](https://www.gnu.org/software/gawk/manual/gawk.html)."
+    },
+    {
+        "name": "visualstudio",
+        "description": "Outputs results to format compatible with the integrated terminal of the [Visual Studio](https://visualstudio.microsoft.com/) IDE. When using Visual Studio, you can click on the linting results in the integrated terminal to go to the issue in the source code."
+    }
+]

package/lib/config/default-config.js

@@ -51,7 +51,7 @@ exports.defaultConfig = [
     // default ignores are listed here
     {
         ignores: [
-            "**/node_modules/**",
+            "**/node_modules/*",
             ".git/"
         ]
     },

package/lib/options.js

@@ -177,7 +177,7 @@ module.exports = function(usingFlatConfig) {
             },
             resolvePluginsFlag,
             {
-                heading: "Specifying rules and plugins"
+                heading: "Specify Rules and Plugins"
             },
             {
                 option: "plugin",
@@ -191,7 +191,7 @@ module.exports = function(usingFlatConfig) {
             },
             rulesDirFlag,
             {
-                heading: "Fixing problems"
+                heading: "Fix Problems"
             },
             {
                 option: "fix",
@@ -211,7 +211,7 @@ module.exports = function(usingFlatConfig) {
                 description: "Specify the types of fixes to apply (directive, problem, suggestion, layout)"
             },
             {
-                heading: "Ignoring files"
+                heading: "Ignore Files"
             },
             ignorePathFlag,
             {
@@ -229,7 +229,7 @@ module.exports = function(usingFlatConfig) {
                 }]
             },
             {
-                heading: "Using stdin"
+                heading: "Use stdin"
             },
             {
                 option: "stdin",
@@ -243,7 +243,7 @@ module.exports = function(usingFlatConfig) {
                 description: "Specify filename to process STDIN as"
             },
             {
-                heading: "Handling warnings"
+                heading: "Handle Warnings"
             },
             {
                 option: "quiet",

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

@@ -619,15 +619,17 @@ class FlatRuleTester {
                 plugins: {
                     "rule-tester": {
                         rules: {
-                            "validate-ast"() {
-                                return {
-                                    Program(node) {
-                                        beforeAST = cloneDeeplyExcludesParent(node);
-                                    },
-                                    "Program:exit"(node) {
-                                        afterAST = node;
-                                    }
-                                };
+                            "validate-ast": {
+                                create() {
+                                    return {
+                                        Program(node) {
+                                            beforeAST = cloneDeeplyExcludesParent(node);
+                                        },
+                                        "Program:exit"(node) {
+                                            afterAST = node;
+                                        }
+                                    };
+                                }
                             }
                         }
                     }

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

@@ -632,14 +632,18 @@ class RuleTester {
              * The goal is to check whether or not AST was modified when
              * running the rule under test.
              */
-            linter.defineRule("rule-tester/validate-ast", () => ({
-                Program(node) {
-                    beforeAST = cloneDeeplyExcludesParent(node);
-                },
-                "Program:exit"(node) {
-                    afterAST = node;
+            linter.defineRule("rule-tester/validate-ast", {
+                create() {
+                    return {
+                        Program(node) {
+                            beforeAST = cloneDeeplyExcludesParent(node);
+                        },
+                        "Program:exit"(node) {
+                            afterAST = node;
+                        }
+                    };
                 }
-            }));
+            });
 
             if (typeof config.parser === "string") {
                 assert(path.isAbsolute(config.parser), "Parsers provided as strings to RuleTester must be absolute paths");

package/lib/rules/comma-dangle.js

@@ -346,7 +346,7 @@ module.exports = {
             "always-multiline": forceTrailingCommaIfMultiline,
             "only-multiline": allowTrailingCommaIfMultiline,
             never: forbidTrailingComma,
-            ignore: () => {}
+            ignore() {}
         };
 
         return {

package/lib/rules/multiline-ternary.js

@@ -73,7 +73,7 @@ module.exports = {
                                 end: lastTokenOfTest.loc.end
                             },
                             messageId: "unexpectedTestCons",
-                            fix: fixer => {
+                            fix(fixer) {
                                 if (hasComments) {
                                     return null;
                                 }
@@ -101,7 +101,7 @@ module.exports = {
                                 end: lastTokenOfConsequent.loc.end
                             },
                             messageId: "unexpectedConsAlt",
-                            fix: fixer => {
+                            fix(fixer) {
                                 if (hasComments) {
                                     return null;
                                 }

package/lib/rules/no-else-return.js

@@ -178,7 +178,7 @@ module.exports = {
             context.report({
                 node,
                 messageId: "unexpected",
-                fix: fixer => {
+                fix(fixer) {
 
                     if (!isSafeFromNameCollisions(node, currentScope)) {
                         return null;

package/lib/rules/no-extra-parens.js

@@ -52,7 +52,8 @@ module.exports = {
                                 enforceForArrowConditionals: { type: "boolean" },
                                 enforceForSequenceExpressions: { type: "boolean" },
                                 enforceForNewInMemberExpressions: { type: "boolean" },
-                                enforceForFunctionPrototypeMethods: { type: "boolean" }
+                                enforceForFunctionPrototypeMethods: { type: "boolean" },
+                                allowParensAfterCommentPattern: { type: "string" }
                             },
                             additionalProperties: false
                         }
@@ -86,6 +87,7 @@ module.exports = {
             context.options[1].enforceForNewInMemberExpressions === false;
         const IGNORE_FUNCTION_PROTOTYPE_METHODS = ALL_NODES && context.options[1] &&
             context.options[1].enforceForFunctionPrototypeMethods === false;
+        const ALLOW_PARENS_AFTER_COMMENT_PATTERN = ALL_NODES && context.options[1] && context.options[1].allowParensAfterCommentPattern;
 
         const PRECEDENCE_OF_ASSIGNMENT_EXPR = precedence({ type: "AssignmentExpression" });
         const PRECEDENCE_OF_UPDATE_EXPR = precedence({ type: "UpdateExpression" });
@@ -402,6 +404,19 @@ module.exports = {
                 if (isIIFE(node) && !isParenthesised(node.callee)) {
                     return;
                 }
+
+                if (ALLOW_PARENS_AFTER_COMMENT_PATTERN) {
+                    const commentsBeforeLeftParenToken = sourceCode.getCommentsBefore(leftParenToken);
+                    const totalCommentsBeforeLeftParenTokenCount = commentsBeforeLeftParenToken.length;
+                    const ignorePattern = new RegExp(ALLOW_PARENS_AFTER_COMMENT_PATTERN, "u");
+
+                    if (
+                        totalCommentsBeforeLeftParenTokenCount > 0 &&
+                        ignorePattern.test(commentsBeforeLeftParenToken[totalCommentsBeforeLeftParenTokenCount - 1].value)
+                    ) {
+                        return;
+                    }
+                }
             }
 
             /**

package/lib/rules/no-invalid-regexp.js

@@ -59,6 +59,20 @@ module.exports = {
             }
         }
 
+        /**
+         * Reports error with the provided message.
+         * @param {ASTNode} node The node holding the invalid RegExp
+         * @param {string} message The message to report.
+         * @returns {void}
+         */
+        function report(node, message) {
+            context.report({
+                node,
+                messageId: "regexMessage",
+                data: { message }
+            });
+        }
+
         /**
          * Check if node is a string
          * @param {ASTNode} node node to evaluate
@@ -108,10 +122,13 @@ module.exports = {
 
         /**
          * Check syntax error in a given flags.
-         * @param {string} flags The RegExp flags to validate.
+         * @param {string|null} flags The RegExp flags to validate.
          * @returns {string|null} The syntax error.
          */
         function validateRegExpFlags(flags) {
+            if (!flags) {
+                return null;
+            }
             try {
                 validator.validateFlags(flags);
                 return null;
@@ -122,34 +139,39 @@ module.exports = {
 
         return {
             "CallExpression, NewExpression"(node) {
-                if (node.callee.type !== "Identifier" || node.callee.name !== "RegExp" || !isString(node.arguments[0])) {
+                if (node.callee.type !== "Identifier" || node.callee.name !== "RegExp") {
                     return;
                 }
-                const pattern = node.arguments[0].value;
+
                 let flags = getFlags(node);
 
                 if (flags && allowedFlags) {
                     flags = flags.replace(allowedFlags, "");
                 }
 
-                const message =
-                    (
-                        flags && validateRegExpFlags(flags)
-                    ) ||
-                    (
+                let message = validateRegExpFlags(flags);
+
+                if (message) {
+                    report(node, message);
+                    return;
+                }
+
+                if (!isString(node.arguments[0])) {
+                    return;
+                }
+
+                const pattern = node.arguments[0].value;
+
+                message = (
 
-                        // If flags are unknown, report the regex only if its pattern is invalid both with and without the "u" flag
-                        flags === null
-                            ? validateRegExpPattern(pattern, true) && validateRegExpPattern(pattern, false)
-                            : validateRegExpPattern(pattern, flags.includes("u"))
-                    );
+                    // If flags are unknown, report the regex only if its pattern is invalid both with and without the "u" flag
+                    flags === null
+                        ? validateRegExpPattern(pattern, true) && validateRegExpPattern(pattern, false)
+                        : validateRegExpPattern(pattern, flags.includes("u"))
+                );
 
                 if (message) {
-                    context.report({
-                        node,
-                        messageId: "regexMessage",
-                        data: { message }
-                    });
+                    report(node, message);
                 }
             }
         };

package/lib/rules/no-return-await.js

@@ -13,6 +13,7 @@ const astUtils = require("./utils/ast-utils");
 /** @type {import('../shared/types').Rule} */
 module.exports = {
     meta: {
+        hasSuggestions: true,
         type: "suggestion",
 
         docs: {
@@ -29,6 +30,7 @@ module.exports = {
         ],
 
         messages: {
+            removeAwait: "Remove redundant `await`.",
             redundantUseOfAwait: "Redundant use of `await` on a return value."
         }
     },
@@ -44,7 +46,32 @@ module.exports = {
             context.report({
                 node: context.getSourceCode().getFirstToken(node),
                 loc: node.loc,
-                messageId: "redundantUseOfAwait"
+                messageId: "redundantUseOfAwait",
+                suggest: [
+                    {
+                        messageId: "removeAwait",
+                        fix(fixer) {
+                            const sourceCode = context.getSourceCode();
+                            const [awaitToken, tokenAfterAwait] = sourceCode.getFirstTokens(node, 2);
+
+                            const areAwaitAndAwaitedExpressionOnTheSameLine = awaitToken.loc.start.line === tokenAfterAwait.loc.start.line;
+
+                            if (!areAwaitAndAwaitedExpressionOnTheSameLine) {
+                                return null;
+                            }
+
+                            const [startOfAwait, endOfAwait] = awaitToken.range;
+
+                            const characterAfterAwait = sourceCode.text[endOfAwait];
+                            const trimLength = characterAfterAwait === " " ? 1 : 0;
+
+                            const range = [startOfAwait, endOfAwait + trimLength];
+
+                            return fixer.removeRange(range);
+                        }
+                    }
+                ]
+
             });
         }
 

package/lib/rules/no-unneeded-ternary.js

@@ -144,7 +144,7 @@ module.exports = {
                     context.report({
                         node,
                         messageId: "unnecessaryConditionalAssignment",
-                        fix: fixer => {
+                        fix(fixer) {
                             const shouldParenthesizeAlternate =
                                 (
                                     astUtils.getPrecedence(node.alternate) < OR_PRECEDENCE ||

package/lib/rules/no-var.js

@@ -159,7 +159,7 @@ function hasReferenceInTDZ(node) {
             return !reference.init && (
                 start < idStart ||
                 (defaultValue !== null && start >= defaultStart && end <= defaultEnd) ||
-                (start >= initStart && end <= initEnd)
+                (!astUtils.isFunction(node) && start >= initStart && end <= initEnd)
             );
         });
     };

package/lib/rules/prefer-named-capture-group.js

@@ -23,6 +23,61 @@ const regexpp = require("regexpp");
 
 const parser = new regexpp.RegExpParser();
 
+/**
+ * Creates fixer suggestions for the regex, if statically determinable.
+ * @param {number} groupStart Starting index of the regex group.
+ * @param {string} pattern The regular expression pattern to be checked.
+ * @param {string} rawText Source text of the regexNode.
+ * @param {ASTNode} regexNode AST node which contains the regular expression.
+ * @returns {Array<SuggestionResult>} Fixer suggestions for the regex, if statically determinable.
+ */
+function suggestIfPossible(groupStart, pattern, rawText, regexNode) {
+    switch (regexNode.type) {
+        case "Literal":
+            if (typeof regexNode.value === "string" && rawText.includes("\\")) {
+                return null;
+            }
+            break;
+        case "TemplateLiteral":
+            if (regexNode.expressions.length || rawText.slice(1, -1) !== pattern) {
+                return null;
+            }
+            break;
+        default:
+            return null;
+    }
+
+    const start = regexNode.range[0] + groupStart + 2;
+
+    return [
+        {
+            fix(fixer) {
+                const existingTemps = pattern.match(/temp\d+/gu) || [];
+                const highestTempCount = existingTemps.reduce(
+                    (previous, next) =>
+                        Math.max(previous, Number(next.slice("temp".length))),
+                    0
+                );
+
+                return fixer.insertTextBeforeRange(
+                    [start, start],
+                    `?<temp${highestTempCount + 1}>`
+                );
+            },
+            messageId: "addGroupName"
+        },
+        {
+            fix(fixer) {
+                return fixer.insertTextBeforeRange(
+                    [start, start],
+                    "?:"
+                );
+            },
+            messageId: "addNonCapture"
+        }
+    ];
+}
+
 //------------------------------------------------------------------------------
 // Rule Definition
 //------------------------------------------------------------------------------
@@ -38,23 +93,29 @@ module.exports = {
             url: "https://eslint.org/docs/rules/prefer-named-capture-group"
         },
 
+        hasSuggestions: true,
+
         schema: [],
 
         messages: {
+            addGroupName: "Add name to capture group.",
+            addNonCapture: "Convert group to non-capturing.",
             required: "Capture group '{{group}}' should be converted to a named or non-capturing group."
         }
     },
 
     create(context) {
+        const sourceCode = context.getSourceCode();
 
         /**
          * Function to check regular expression.
-         * @param {string} pattern The regular expression pattern to be check.
-         * @param {ASTNode} node AST node which contains regular expression.
+         * @param {string} pattern The regular expression pattern to be checked.
+         * @param {ASTNode} node AST node which contains the regular expression or a call/new expression.
+         * @param {ASTNode} regexNode AST node which contains the regular expression.
          * @param {boolean} uFlag Flag indicates whether unicode mode is enabled or not.
          * @returns {void}
          */
-        function checkRegex(pattern, node, uFlag) {
+        function checkRegex(pattern, node, regexNode, uFlag) {
             let ast;
 
             try {
@@ -68,12 +129,16 @@ module.exports = {
             regexpp.visitRegExpAST(ast, {
                 onCapturingGroupEnter(group) {
                     if (!group.name) {
+                        const rawText = sourceCode.getText(regexNode);
+                        const suggest = suggestIfPossible(group.start, pattern, rawText, regexNode);
+
                         context.report({
                             node,
                             messageId: "required",
                             data: {
                                 group: group.raw
-                            }
+                            },
+                            suggest
                         });
                     }
                 }
@@ -83,7 +148,7 @@ module.exports = {
         return {
             Literal(node) {
                 if (node.regex) {
-                    checkRegex(node.regex.pattern, node, node.regex.flags.includes("u"));
+                    checkRegex(node.regex.pattern, node, node, node.regex.flags.includes("u"));
                 }
             },
             Program() {
@@ -101,7 +166,7 @@ module.exports = {
                     const flags = getStringIfConstant(node.arguments[1]);
 
                     if (regex) {
-                        checkRegex(regex, node, flags && flags.includes("u"));
+                        checkRegex(regex, node, node.arguments[0], flags && flags.includes("u"));
                     }
                 }
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint",
-  "version": "8.28.0",
+  "version": "8.30.0",
   "author": "Nicholas C. Zakas <nicholas+npm@nczconsulting.com>",
   "description": "An AST-based pattern checker for JavaScript.",
   "bin": {
@@ -13,22 +13,22 @@
     "./use-at-your-own-risk": "./lib/unsupported-api.js"
   },
   "scripts": {
+    "build:docs:update-links": "node tools/fetch-docs-links.js",
+    "release:generate:latest": "node Makefile.js generateRelease",
+    "release:generate:alpha": "node Makefile.js generatePrerelease -- alpha",
+    "release:generate:beta": "node Makefile.js generatePrerelease -- beta",
+    "release:publish": "node Makefile.js publishRelease",
+    "release:generate:rc": "node Makefile.js generatePrerelease -- rc",
+    "build:site": "node Makefile.js gensite",
+    "build:webpack": "node Makefile.js webpack",
+    "lint": "node Makefile.js lint",
+    "lint:fix": "node Makefile.js lint -- fix",
+    "lint:docs:js": "node Makefile.js lintDocsJS",
+    "lint:fix:docs:js": "node Makefile.js lintDocsJS -- fix",
     "test": "node Makefile.js test",
     "test:cli": "mocha",
-    "lint": "node Makefile.js lint",
-    "lint:docsjs": "node Makefile.js lintDocsJS",
-    "fix": "node Makefile.js lint -- fix",
-    "fix:docsjs": "node Makefile.js lintDocsJS -- fix",
-    "fuzz": "node Makefile.js fuzz",
-    "generate-release": "node Makefile.js generateRelease",
-    "generate-alpharelease": "node Makefile.js generatePrerelease -- alpha",
-    "generate-betarelease": "node Makefile.js generatePrerelease -- beta",
-    "generate-rcrelease": "node Makefile.js generatePrerelease -- rc",
-    "publish-release": "node Makefile.js publishRelease",
-    "gensite": "node Makefile.js gensite",
-    "webpack": "node Makefile.js webpack",
-    "perf": "node Makefile.js perf",
-    "docs:update-links": "node tools/fetch-docs-links.js"
+    "test:fuzz": "node Makefile.js fuzz",
+    "test:performance": "node Makefile.js perf"
   },
   "gitHooks": {
     "pre-commit": "lint-staged"
@@ -55,8 +55,8 @@
   "homepage": "https://eslint.org",
   "bugs": "https://github.com/eslint/eslint/issues/",
   "dependencies": {
-    "@eslint/eslintrc": "^1.3.3",
-    "@humanwhocodes/config-array": "^0.11.6",
+    "@eslint/eslintrc": "^1.4.0",
+    "@humanwhocodes/config-array": "^0.11.8",
     "@humanwhocodes/module-importer": "^1.0.1",
     "@nodelib/fs.walk": "^1.2.8",
     "ajv": "^6.10.0",
@@ -75,7 +75,7 @@
     "file-entry-cache": "^6.0.1",
     "find-up": "^5.0.0",
     "glob-parent": "^6.0.2",
-    "globals": "^13.15.0",
+    "globals": "^13.19.0",
     "grapheme-splitter": "^1.0.4",
     "ignore": "^5.2.0",
     "import-fresh": "^3.0.0",