fix: escape double quotes for ts outputStringLiterals (#1097)

* fix: escape double quotes for ts outputStringLiterals * docs: add changeset
amzn · Feb 8, 2024 · cd9f484 · cd9f484
1 parent b3f5d86
commit cd9f484
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 3 deletions.
diff --git a/.changeset/green-wolves-heal.md b/.changeset/green-wolves-heal.md
@@ -0,0 +1,5 @@
+---
+'style-dictionary': patch
+---
+
+Escape double quotes for ts outputStringLiterals
diff --git a/__tests__/common/formatHelpers/getTypeScriptType.test.js b/__tests__/common/formatHelpers/getTypeScriptType.test.js
@@ -62,9 +62,9 @@ describe('common', () => {
       });
 
       it('should handle outputStringLiterals', () => {
-        const stringValue = 'I am a string';
+        const stringValue = 'I "am" a string';
         const options = { outputStringLiterals: true };
-        expect(getTypeScriptType(stringValue, options)).to.equal(`"${stringValue}"`);
+        expect(getTypeScriptType(stringValue, options)).to.equal('"I \\"am\\" a string"');
       });
     });
   });

diff --git a/__tests__/formats/__snapshots__/typeScriptEs6Declarations.test.snap.js b/__tests__/formats/__snapshots__/typeScriptEs6Declarations.test.snap.js
@@ -9,6 +9,7 @@ snapshots["formats typescript/es6-declarations with outputStringLiterals should
 
 /** Used for errors */
 export const colorRed : "#FF0000";
+export const fontFamily : "\\"Source Sans Pro\\", Arial, sans-serif";
 `;
 /* end snapshot formats typescript/es6-declarations with outputStringLiterals should match snapshot */
 
diff --git a/__tests__/formats/typeScriptEs6Declarations.test.js b/__tests__/formats/typeScriptEs6Declarations.test.js
@@ -28,6 +28,12 @@ const tokens = {
       value: '#FF0000',
     },
   },
+  font: {
+    family: {
+      name: 'fontFamily',
+      value: '"Source Sans Pro", Arial, sans-serif',
+    },
+  },
 };
 
 const format = formats['typescript/es6-declarations'];

diff --git a/lib/common/formatHelpers/getTypeScriptType.js b/lib/common/formatHelpers/getTypeScriptType.js
@@ -45,7 +45,7 @@ export default function getTypeScriptType(value, options = {}) {
 
   if (Array.isArray(value)) return getArrayType(value);
   if (typeof value === 'object') return getObjectType(value);
-  if (outputStringLiterals && typeof value === 'string') return `"${value}"`;
+  if (outputStringLiterals && typeof value === 'string') return `"${value.replace(/"/g, '\\"')}"`;
   if (['string', 'number', 'boolean'].includes(typeof value)) return typeof value;
 
   return 'any';