Escape quotes (#98)

* escape singleQuotes in rendering of fields and such

* trying to pass tests

* properly escape

* remove unnecessary escapes

* remove more unneccessary escapes

* Update src/renderers/contentful/renderContentType.ts

Co-authored-by: Gabriel Anca Corral <[email protected]>

* Remove unused import

Co-authored-by: Jaden Giordano <[email protected]>
Co-authored-by: Gabriel Anca Corral <[email protected]>

Author: 3 people

src/renderers/contentful/fields/renderSymbol.ts

@@ -1,12 +1,13 @@
 import { Field } from "contentful"
 
 import { renderUnionValues } from "../../typescript/renderUnion"
+import { escapeSingleQuotes } from "../../utils"
 
 export default function renderSymbol(field: Field) {
   const inValidation = field.validations.find(validation => !!validation.in)
 
   if (inValidation) {
-    return renderUnionValues(inValidation.in!.map(value => `'${value}'`))
+    return renderUnionValues(inValidation.in!.map(value => `'${escapeSingleQuotes(value)}'`))
   } else {
     return "string"
   }

src/renderers/contentful/renderAllLocales.ts

@@ -2,5 +2,8 @@ import renderUnion from "../typescript/renderUnion"
 import { Locale } from "contentful"
 
 export default function renderAllLocales(locales: Locale[]): string {
-  return renderUnion("LOCALE_CODE", locales.map(locale => `'${locale.code}'`))
+  return renderUnion(
+    "LOCALE_CODE",
+    locales.map(locale => `'${locale.code}'`),
+  )
 }

src/renderers/render.ts

@@ -45,5 +45,8 @@ function renderAllContentTypes(contentTypes: ContentType[], localization: boolea
 }
 
 function renderAllContentTypeIds(contentTypes: ContentType[]): string {
-  return renderUnion("CONTENT_TYPE", contentTypes.map(contentType => `'${contentType.sys.id}'`))
+  return renderUnion(
+    "CONTENT_TYPE",
+    contentTypes.map(contentType => `'${contentType.sys.id}'`),
+  )
 }

src/renderers/utils.ts

@@ -0,0 +1,3 @@
+export function escapeSingleQuotes(str: string = ""): string {
+  return str.replace(/'/g, "\\'")
+}

test/renderers/render.test.ts

@@ -17,7 +17,7 @@ describe("render()", () => {
             type: "Symbol",
             validations: [
               {
-                in: ["one", "of", "the", "above"],
+                in: ["one's", "of", "the", "above"],
               },
             ],
           },
@@ -60,7 +60,7 @@ describe("render()", () => {
 
       export interface IMyContentTypeFields {
         /** Array field */
-        arrayField: (\\"one\\" | \\"of\\" | \\"the\\" | \\"above\\")[]
+        arrayField: (\\"one's\\" | \\"of\\" | \\"the\\" | \\"above\\")[]
       }
 
       export interface IMyContentType extends Entry<IMyContentTypeFields> {
@@ -105,7 +105,7 @@ describe("render()", () => {
               type: "Symbol",
               validations: [
                 {
-                  in: ["one", "of", "the", "above"],
+                  in: ["one's", "of", "the", "above"],
                 },
               ],
             },
@@ -130,7 +130,7 @@ describe("render()", () => {
 
       export interface IMyContentTypeFields {
         /** Array field */
-        arrayField: LocalizedField<(\\"one\\" | \\"of\\" | \\"the\\" | \\"above\\")[]>
+        arrayField: LocalizedField<(\\"one's\\" | \\"of\\" | \\"the\\" | \\"above\\")[]>
       }
 
       export interface IMyContentType extends Entry<IMyContentTypeFields> {
@@ -193,7 +193,7 @@ describe("render()", () => {
       declare namespace Codegen {
         export interface IMyContentTypeFields {
           /** Array field */
-          arrayField: (\\"one\\" | \\"of\\" | \\"the\\" | \\"above\\")[]
+          arrayField: (\\"one's\\" | \\"of\\" | \\"the\\" | \\"above\\")[]
         }
 
         export interface IMyContentType extends Entry<IMyContentTypeFields> {

test/renderers/utils.test.ts

@@ -0,0 +1,25 @@
+import { escapeSingleQuotes } from "../../src/renderers/utils"
+
+describe("escapeSingleQuotes()", () => {
+  const testStrings = [
+    "one's",
+    "no quotes",
+    "the quote's pie",
+    "Tom's pie is better than quote's pie",
+    "Alot of quotes after '''''",
+    "''''' Alot of quotes before",
+  ]
+
+  const escapedStrings = [
+    "one\\'s",
+    "no quotes",
+    "the quote\\'s pie",
+    "Tom\\'s pie is better than quote\\'s pie",
+    "Alot of quotes after \\'\\'\\'\\'\\'",
+    "\\'\\'\\'\\'\\' Alot of quotes before",
+  ]
+
+  it("escapes all the single quotes", () => {
+    expect(testStrings.map(escapeSingleQuotes)).toStrictEqual(escapedStrings)
+  })
+})