highlight escape sequence rather than quasi (#103)

43081j · Jun 7, 2021 · 51c53c7 · 51c53c7
1 parent 27a6e8b
commit 51c53c7
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 13 deletions.
diff --git a/src/rules/no-invalid-escape-sequences.ts b/src/rules/no-invalid-escape-sequences.ts
@@ -18,16 +18,17 @@ const rule: Rule.RuleModule = {
       url:
         'https://github.com/43081j/eslint-plugin-lit/blob/master/docs/rules/no-invalid-escape-sequences.md'
     },
+    fixable: 'code',
     messages: {
       invalid:
         'Some escape sequences are invalid in template strings. ' +
-        'They should either be escaped again (e.g. "\\02c") or interpolated'
+        'They should either be escaped again (e.g. "\\\\02c") or interpolated'
     }
   },
 
   create(context): Rule.RuleListener {
-    // variables should be defined here
-    const escapePattern = /(^|[^\\])\\([1-7][0-7]*|[0-7]{2,})+/;
+    const source = context.getSourceCode();
+    const escapePattern = /(^|[^\\](?:\\\\)*)(\\([1-7][0-7]*|[0-7]{2,}))/g;
 
     return {
       TaggedTemplateExpression: (node: ESTree.Node): void => {
@@ -37,11 +38,24 @@ const rule: Rule.RuleModule = {
           node.tag.name === 'html'
         ) {
           for (const quasi of node.quasi.quasis) {
-            if (escapePattern.test(quasi.value.raw)) {
-              context.report({
-                node: quasi,
-                messageId: 'invalid'
-              });
+            if (quasi.range) {
+              const results = quasi.value.raw.matchAll(escapePattern);
+
+              for (const match of results) {
+                if (match.index !== undefined) {
+                  const rangeStart =
+                    quasi.range[0] + 1 + match.index + match[1].length;
+                  const rangeEnd = rangeStart + match[2].length;
+                  const start = source.getLocFromIndex(rangeStart);
+                  const end = source.getLocFromIndex(rangeEnd);
+                  context.report({
+                    loc: {start, end},
+                    messageId: 'invalid',
+                    fix: (fixer) =>
+                      fixer.insertTextBeforeRange([rangeStart, rangeEnd], '\\')
+                  });
+                }
+              }
             }
           }
         }

diff --git a/src/test/rules/no-invalid-escape-sequences_test.ts b/src/test/rules/no-invalid-escape-sequences_test.ts
@@ -40,9 +40,12 @@ ruleTester.run('no-invalid-escape-sequences', rule, {
         {
           messageId: 'invalid',
           line: 1,
-          column: 5
+          column: 10,
+          endLine: 1,
+          endColumn: 15
         }
-      ]
+      ],
+      output: 'html`foo \\\\0123 bar`'
     },
     {
       code: 'html`foo \\3c bar`',
@@ -51,9 +54,33 @@ ruleTester.run('no-invalid-escape-sequences', rule, {
         {
           messageId: 'invalid',
           line: 1,
-          column: 5
+          column: 10,
+          endLine: 1,
+          endColumn: 12
         }
-      ]
+      ],
+      output: 'html`foo \\\\3c bar`'
+    },
+    {
+      code: 'html`foo \\3c bar \\33`',
+      parserOptions: {ecmaVersion: 2018},
+      errors: [
+        {
+          messageId: 'invalid',
+          line: 1,
+          column: 10,
+          endLine: 1,
+          endColumn: 12
+        },
+        {
+          messageId: 'invalid',
+          line: 1,
+          column: 18,
+          endLine: 1,
+          endColumn: 21
+        }
+      ],
+      output: 'html`foo \\\\3c bar \\\\33`'
     }
   ]
 });
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
-    "target": "es2017",
+    "target": "es2020",
     "module": "commonjs",
     "declaration": true,
     "outDir": "./lib",