feat: add suggestions

eslint · Nov 12, 2022 · 4b1241a · 4b1241a
1 parent 79b6340
commit 4b1241a
Show file tree

Hide file tree

Showing 2 changed files with 295 additions and 24 deletions.
diff --git a/lib/rules/prefer-named-capture-group.js b/lib/rules/prefer-named-capture-group.js
@@ -38,23 +38,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 {ASTNode} node AST node which contains regular expression or a call/new expression.
+         * @param {ASTNode} regexNode AST node which contains 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 +74,35 @@ module.exports = {
             regexpp.visitRegExpAST(ast, {
                 onCapturingGroupEnter(group) {
                     if (!group.name) {
+                        const rawText = sourceCode.getText(regexNode);
+                        const start = regexNode.range[0] + rawText.indexOf("(", group.start) + 1;
+
                         context.report({
                             node,
                             messageId: "required",
                             data: {
                                 group: group.raw
-                            }
+                            },
+                            suggest: [
+                                {
+                                    fix(fixer) {
+                                        return fixer.insertTextBeforeRange(
+                                            [start, start],
+                                            `?<temp${(pattern.match(/temp\d+/gu)?.length ?? 0) + 1}>`
+                                        );
+                                    },
+                                    messageId: "addGroupName"
+                                },
+                                {
+                                    fix(fixer) {
+                                        return fixer.insertTextBeforeRange(
+                                            [start, start],
+                                            "?:"
+                                        );
+                                    },
+                                    messageId: "addNonCapture"
+                                }
+                            ]
                         });
                     }
                 }
@@ -83,7 +112,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 +130,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"));
                     }
                 }
             }