fix: escape string and template literal (#8)

antfu · May 3, 2024 · 4fef1d3 · 4fef1d3
1 parent f9fa194
commit 4fef1d3
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 11 deletions.
diff --git a/src/commands/to-string-literal.test.ts b/src/commands/to-string-literal.test.ts
@@ -9,7 +9,7 @@ run(
     const a = \`a\`; const b = \`b\`; const c = 'c';
     `,
     output: d`
-    const a = 'a'; const b = 'b'; const c = 'c';
+    const a = "a"; const b = "b"; const c = 'c';
     `,
     errors: ['command-removal', 'command-fix', 'command-fix'],
   },
@@ -20,7 +20,7 @@ run(
     const a = \`a\`, b = \`b\`, c = \`c\`, d = \`d\`;
     `,
     output: d`
-    const a = \`a\`, b = 'b', c = 'c', d = \`d\`;
+    const a = \`a\`, b = "b", c = "c", d = \`d\`;
     `,
     errors: ['command-removal', 'command-fix', 'command-fix'],
   },
@@ -31,7 +31,7 @@ run(
     const a = 'a', b = 'b', c = \`c\`, d = 'd', e = \`e\`, f = \`f\`;
     `,
     output: d`
-    const a = 'a', b = 'b', c = 'c', d = 'd', e = \`e\`, f = 'f';
+    const a = 'a', b = 'b', c = "c", d = 'd', e = \`e\`, f = "f";
     `,
     errors: ['command-removal', 'command-fix', 'command-fix'],
   },
@@ -42,7 +42,18 @@ run(
     const a = \`\${g}a\${a}a\${b}c\${d}e\${a}\`;
     `,
     output: d`
-    const a = g + 'a' + a + 'a' + b + 'c' + d + 'e' + a;
+    const a = g + "a" + a + "a" + b + "c" + d + "e" + a;
+    `,
+    errors: ['command-removal', 'command-fix'],
+  },
+  // escape
+  {
+    code: d`
+    // @2sl
+    const a = \`"\\"\\\\"\`
+    `,
+    output: d`
+    const a = "\\"\\\\\\"\\\\\\\\\\""
     `,
     errors: ['command-removal', 'command-fix'],
   },

diff --git a/src/commands/to-string-literal.ts b/src/commands/to-string-literal.ts
@@ -19,12 +19,12 @@ export const toStringLiteral: Command = {
     ctx.removeComment()
     for (const node of getNodesByIndexes(nodes, indexes)) {
       const ids = extractIdentifiers(node)
-      let raw = ctx.source.getText(node).slice(1, -1)
+      let raw = JSON.stringify(ctx.source.getText(node).slice(1, -1)).slice(1, -1)
 
       if (ids.length)
         raw = toStringWithIds(raw, node, ids)
       else
-        raw = `'${raw}'`
+        raw = `"${raw}"`
 
       ctx.report({
         node,
@@ -56,8 +56,8 @@ function toStringWithIds(raw: string, node: Tree.TemplateLiteral, ids: Identifie
   let hasStart = false
   let hasEnd = false
   ids.forEach(({ name, range }, index) => {
-    let startStr = `' + `
-    let endStr = ` + '`
+    let startStr = `" + `
+    let endStr = ` + "`
 
     if (index === 0) {
       hasStart = range[0] - /* `${ */3 === node.range[0]
@@ -72,5 +72,5 @@ function toStringWithIds(raw: string, node: Tree.TemplateLiteral, ids: Identifie
 
     raw = raw.replace(`\${${name}}`, `${startStr}${name}${endStr}`)
   })
-  return `${hasStart ? '' : `'`}${raw}${hasEnd ? '' : `'`}`
+  return `${hasStart ? '' : `"`}${raw}${hasEnd ? '' : `"`}`
 }
diff --git a/src/commands/to-template-literal.test.ts b/src/commands/to-template-literal.test.ts
@@ -86,4 +86,35 @@ run(
     `,
     errors: ['command-removal', 'command-fix', 'command-fix'],
   },
+  // escape
+  {
+    code: d`
+    // @2tl
+    const a = "\`"
+    `,
+    output: d`
+    const a = \`\\\`\`
+    `,
+    errors: ['command-removal', 'command-fix'],
+  },
+  {
+    code: d`
+    // @2tl
+    const a = str + "\`" 
+    `,
+    output: d`
+    const a = \`\${str}\\\`\` 
+    `,
+    errors: ['command-removal', 'command-fix'],
+  },
+  {
+    code: d`
+    // @2tl
+    const a = "\${str}"
+    `,
+    output: d`
+    const a = \`\\\${str}\`
+    `,
+    errors: ['command-removal', 'command-fix'],
+  },
 )
diff --git a/src/commands/to-template-literal.ts b/src/commands/to-template-literal.ts
@@ -51,7 +51,7 @@ function getExpressionValue(node: Tree.Expression | Tree.PrivateIdentifier) {
   if (node.type === 'Identifier')
     return `\${${node.name}}`
   if (node.type === 'Literal' && typeof node.value === 'string')
-    return node.value
+    return escape(node.value)
 
   return ''
 }
@@ -76,7 +76,7 @@ function traverseBinaryExpression(node: Tree.BinaryExpression): string {
 }
 
 function convertStringLiteral(node: Tree.StringLiteral, ctx: CommandContext) {
-  const raw = `\`${node.value}\``
+  const raw = `\`${escape(node.value)}\``
   report(ctx, node, raw)
 }
 
@@ -89,3 +89,8 @@ function report(ctx: CommandContext, node: Tree.Node, raw: string) {
     },
   })
 }
+
+function escape(raw: string) {
+  // TODO handle multi escape characters '\\${str}'
+  return raw.replace(/`/g, '\\`').replace(/\$\{/g, '\\${')
+}