Added suggestions for no-octal (#131)

* Added suggestions for `no-octal`

* Add test cases for suggestions (#134)

Co-authored-by: Yosuke Ota <[email protected]>

Author: RunDevelopment

lib/rules/no-octal.ts

@@ -1,6 +1,11 @@
 import type { Expression } from "estree"
 import type { RegExpVisitor } from "regexpp/visitor"
-import { createRule, defineRegexpVisitor, getRegexpLocation } from "../utils"
+import {
+    createRule,
+    defineRegexpVisitor,
+    fixReplaceNode,
+    getRegexpLocation,
+} from "../utils"
 
 export default createRule("no-octal", {
     meta: {
@@ -11,6 +16,8 @@ export default createRule("no-octal", {
         schema: [],
         messages: {
             unexpected: "Unexpected octal escape sequence '{{expr}}'.",
+            replaceHex:
+                "Replace the octal escape sequence with a hexadecimal escape sequence.",
         },
         type: "suggestion", // "problem",
     },
@@ -51,6 +58,21 @@ export default createRule("no-octal", {
                             data: {
                                 expr: cNode.raw,
                             },
+                            suggest: [
+                                {
+                                    messageId: "replaceHex",
+                                    fix: fixReplaceNode(
+                                        sourceCode,
+                                        node,
+                                        cNode,
+                                        () => {
+                                            return `\\x${cNode.value
+                                                .toString(16)
+                                                .padStart(2, "0")}`
+                                        },
+                                    ),
+                                },
+                            ],
                         })
                     }
                 },

tests/lib/rules/no-octal.ts

@@ -18,6 +18,13 @@ tester.run("no-octal", rule as any, {
                     message: "Unexpected octal escape sequence '\\07'.",
                     column: 2,
                     endColumn: 5,
+                    suggestions: [
+                        {
+                            desc:
+                                "Replace the octal escape sequence with a hexadecimal escape sequence.",
+                            output: String.raw`/\x07/`,
+                        },
+                    ],
                 },
             ],
         },
@@ -28,12 +35,30 @@ tester.run("no-octal", rule as any, {
                     message: "Unexpected octal escape sequence '\\077'.",
                     column: 2,
                     endColumn: 6,
+                    suggestions: [
+                        {
+                            desc:
+                                "Replace the octal escape sequence with a hexadecimal escape sequence.",
+                            output: String.raw`/\x3f/`,
+                        },
+                    ],
                 },
             ],
         },
         {
             code: "/[\\077]/",
-            errors: [{ message: "Unexpected octal escape sequence '\\077'." }],
+            errors: [
+                {
+                    message: "Unexpected octal escape sequence '\\077'.",
+                    suggestions: [
+                        {
+                            desc:
+                                "Replace the octal escape sequence with a hexadecimal escape sequence.",
+                            output: String.raw`/[\x3f]/`,
+                        },
+                    ],
+                },
+            ],
         },
         {
             code: "/\\0777/",
@@ -42,23 +67,70 @@ tester.run("no-octal", rule as any, {
                     message: "Unexpected octal escape sequence '\\077'.",
                     column: 2,
                     endColumn: 6,
+                    suggestions: [
+                        {
+                            desc:
+                                "Replace the octal escape sequence with a hexadecimal escape sequence.",
+                            output: String.raw`/\x3f7/`,
+                        },
+                    ],
                 },
             ],
         },
         {
             code: "/\\7/",
-            errors: [{ message: "Unexpected octal escape sequence '\\7'." }],
+            errors: [
+                {
+                    message: "Unexpected octal escape sequence '\\7'.",
+                    suggestions: [
+                        {
+                            desc:
+                                "Replace the octal escape sequence with a hexadecimal escape sequence.",
+                            output: String.raw`/\x07/`,
+                        },
+                    ],
+                },
+            ],
         },
         {
             code: "/\\1\\2/",
             errors: [
-                { message: "Unexpected octal escape sequence '\\1'." },
-                { message: "Unexpected octal escape sequence '\\2'." },
+                {
+                    message: "Unexpected octal escape sequence '\\1'.",
+                    suggestions: [
+                        {
+                            desc:
+                                "Replace the octal escape sequence with a hexadecimal escape sequence.",
+                            output: String.raw`/\x01\2/`,
+                        },
+                    ],
+                },
+                {
+                    message: "Unexpected octal escape sequence '\\2'.",
+                    suggestions: [
+                        {
+                            desc:
+                                "Replace the octal escape sequence with a hexadecimal escape sequence.",
+                            output: String.raw`/\1\x02/`,
+                        },
+                    ],
+                },
             ],
         },
         {
             code: "/()\\1\\2/",
-            errors: [{ message: "Unexpected octal escape sequence '\\2'." }],
+            errors: [
+                {
+                    message: "Unexpected octal escape sequence '\\2'.",
+                    suggestions: [
+                        {
+                            desc:
+                                "Replace the octal escape sequence with a hexadecimal escape sequence.",
+                            output: String.raw`/()\1\x02/`,
+                        },
+                    ],
+                },
+            ],
         },
     ],
 })