refactor: extract singleQuote utility

Author: hanna-skryl

packages/create-cli/src/lib/setup/codegen.ts

@@ -1,6 +1,10 @@
 import path from 'node:path';
 import type { CategoryRef } from '@code-pushup/models';
-import { mergeCategoriesBySlug, toUnixPath } from '@code-pushup/utils';
+import {
+  mergeCategoriesBySlug,
+  singleQuote,
+  toUnixPath,
+} from '@code-pushup/utils';
 import type {
   ConfigFileFormat,
   ImportDeclarationStructure,
@@ -195,15 +199,12 @@ function addCategories(
   categories.forEach(({ slug, title, description, docsUrl, refs }) => {
     builder.addLine('{', depth + 1);
     builder.addLine(`slug: '${slug}',`, depth + 2);
-    builder.addLine(`title: ${toJsStringLiteral(title)},`, depth + 2);
+    builder.addLine(`title: ${singleQuote(title)},`, depth + 2);
     if (description) {
-      builder.addLine(
-        `description: ${toJsStringLiteral(description)},`,
-        depth + 2,
-      );
+      builder.addLine(`description: ${singleQuote(description)},`, depth + 2);
     }
     if (docsUrl) {
-      builder.addLine(`docsUrl: ${toJsStringLiteral(docsUrl)},`, depth + 2);
+      builder.addLine(`docsUrl: ${singleQuote(docsUrl)},`, depth + 2);
     }
     builder.addLine('refs: [', depth + 2);
     builder.addLines(refs.map(formatCategoryRef), depth + 3);
@@ -216,11 +217,3 @@ function addCategories(
 function formatCategoryRef(ref: CategoryRef): string {
   return `{ type: '${ref.type}', plugin: '${ref.plugin}', slug: '${ref.slug}', weight: ${ref.weight} },`;
 }
-
-/** Wraps a value in single-quoted JS string literal with special characters escaped. */
-function toJsStringLiteral(value: string): string {
-  const inner = JSON.stringify(value)
-    .slice(1, -1)
-    .replace(/'/g, String.raw`\'`);
-  return `'${inner}'`;
-}

packages/utils/src/index.ts

@@ -60,6 +60,7 @@ export {
   pluralizeToken,
   roundDecimals,
   serializeCommandWithArgs,
+  singleQuote,
   slugify,
   transformLines,
   truncateDescription,

packages/utils/src/lib/formatting.ts

@@ -196,3 +196,12 @@ export function formatCoveragePercentage(stats: {
   const percentage = (covered / total) * 100;
   return `${percentage.toFixed(1)}%`;
 }
+
+/** Escapes a string and wraps it in single quotes for use in JS code. */
+export function singleQuote(value: string): string {
+  const inner = JSON.stringify(value)
+    .slice(1, -1)
+    .replace(/\\"/g, '"')
+    .replace(/'/g, String.raw`\'`);
+  return `'${inner}'`;
+}

packages/utils/src/lib/formatting.unit.test.ts

@@ -10,6 +10,7 @@ import {
   pluralizeToken,
   roundDecimals,
   serializeCommandWithArgs,
+  singleQuote,
   slugify,
   transformLines,
   truncateMultilineText,
@@ -320,3 +321,21 @@ describe('formatCoveragePercentage', () => {
     expect(formatCoveragePercentage({ covered: 0, total: 0 })).toBe('-');
   });
 });
+
+describe('singleQuote', () => {
+  it.each([
+    ['hello', "'hello'"],
+    ["it's", String.raw`'it\'s'`],
+    [String.raw`back\slash`, String.raw`'back\\slash'`],
+    ['line\nbreak', String.raw`'line\nbreak'`],
+  ])(
+    'should escape %j for use in a single-quoted JS literal',
+    (input, expected) => {
+      expect(singleQuote(input)).toBe(expected);
+    },
+  );
+
+  it('should leave double quotes unescaped', () => {
+    expect(singleQuote('say "hi"')).toBe(`'say "hi"'`);
+  });
+});