Added prefix and suffix support

src/contentful-typescript-codegen.ts

@@ -13,6 +13,10 @@ const cli = meow(
   Options
     --output,      -o  Where to write to
     --poll,        -p  Continuously refresh types
+    --prefix STR,  -P  Define prefix STR for types, defaults to 'I'
+    --suffix STR,  -S  Define suffix STR for types, defaults to empty string
+    --no-prefix,   -nP Disable prefix completely
+    --no-suffix,   -nS Disable suffix completely
     --interval N,  -i  The interval in seconds at which to poll (defaults to 15)
     --namespace N, -n  Wrap types in namespace N (disabled by default)
     --fields-only      Output a tree that _only_ ensures fields are valid
@@ -40,6 +44,26 @@ const cli = meow(
         alias: "p",
         required: false,
       },
+      prefix: {
+        type: "string",
+        alias: "P",
+        required: false,
+      },
+      suffix: {
+        type: "string",
+        alias: "S",
+        required: false,
+      },
+      noPrefix: {
+        type: "boolean",
+        alias: "nP",
+        required: false,
+      },
+      noSuffix: {
+        type: "boolean",
+        alias: "nS",
+        required: false,
+      },
       interval: {
         type: "string",
         alias: "i",
@@ -69,11 +93,17 @@ async function runCodegen(outputFile: string) {
 
   let output
   if (cli.flags.fieldsOnly) {
-    output = await renderFieldsOnly(contentTypes.items, { namespace: cli.flags.namespace })
+    output = await renderFieldsOnly(contentTypes.items, {
+      namespace: cli.flags.namespace,
+      prefix: cli.flags.noPrefix ? "" : cli.flags.prefix,
+      suffix: cli.flags.noSuffix ? "" : cli.flags.suffix,
+    })
   } else {
     output = await render(contentTypes.items, locales.items, {
       localization: cli.flags.localization,
       namespace: cli.flags.namespace,
+      prefix: cli.flags.noPrefix ? "" : cli.flags.prefix,
+      suffix: cli.flags.noSuffix ? "" : cli.flags.suffix,
     })
   }
 

src/renderers/contentful-fields-only/fields/renderArray.ts

@@ -2,8 +2,9 @@ import { Field } from "contentful"
 import renderSymbol from "../../contentful/fields/renderSymbol"
 import renderLink from "../../contentful-fields-only/fields/renderLink"
 import renderArrayOf from "../../typescript/renderArrayOf"
+import { Options } from "../../renderFieldsOnly"
 
-export default function renderArray(field: Field): string {
+export default function renderArray(field: Field, options: Options): string {
   if (!field.items) {
     throw new Error(`Cannot render non-array field ${field.id} as an array`)
   }
@@ -20,9 +21,7 @@ export default function renderArray(field: Field): string {
     }
 
     case "Link": {
-      return renderArrayOf(renderLink(fieldWithValidations))
+      return renderArrayOf(renderLink(fieldWithValidations, options))
     }
   }
-
-  return renderArrayOf("unknown")
 }

src/renderers/contentful-fields-only/fields/renderLink.ts

@@ -1,8 +1,9 @@
 import { Field } from "contentful"
 import renderContentTypeId from "../../contentful/renderContentTypeId"
 import { renderUnionValues } from "../../typescript/renderUnion"
+import { Options } from "../../renderFieldsOnly"
 
-export default function renderLink(field: Field): string {
+export default function renderLink(field: Field, options: Options): string {
   if (field.linkType === "Asset") {
     return "any"
   }
@@ -11,7 +12,9 @@ export default function renderLink(field: Field): string {
     const contentTypeValidation = field.validations.find(validation => !!validation.linkContentType)
 
     if (contentTypeValidation) {
-      return renderUnionValues(contentTypeValidation.linkContentType!.map(renderContentTypeId))
+      return renderUnionValues(
+        contentTypeValidation.linkContentType!.map(link => renderContentTypeId(link, options)),
+      )
     } else {
       return "unknown"
     }

src/renderers/contentful-fields-only/renderContentType.ts

@@ -1,5 +1,7 @@
 import { ContentType, Field, FieldType } from "contentful"
 
+import { Options } from "../renderFieldsOnly"
+
 import renderInterface from "../typescript/renderInterface"
 import renderField from "../contentful/renderField"
 import renderContentTypeId from "../contentful/renderContentTypeId"
@@ -14,9 +16,9 @@ import renderNumber from "../contentful/fields/renderNumber"
 import renderObject from "../contentful/fields/renderObject"
 import renderSymbol from "../contentful/fields/renderSymbol"
 
-export default function renderContentType(contentType: ContentType): string {
-  const name = renderContentTypeId(contentType.sys.id)
-  const fields = renderContentTypeFields(contentType.fields)
+export default function renderContentType(contentType: ContentType, options: Options): string {
+  const name = renderContentTypeId(contentType.sys.id, options)
+  const fields = renderContentTypeFields(contentType.fields, options)
 
   return renderInterface({
     name,
@@ -27,11 +29,11 @@ export default function renderContentType(contentType: ContentType): string {
   })
 }
 
-function renderContentTypeFields(fields: Field[]): string {
+function renderContentTypeFields(fields: Field[], options: Options): string {
   return fields
     .filter(field => !field.omitted)
     .map<string>(field => {
-      const functionMap: Record<FieldType, (field: Field) => string> = {
+      const functionMap: Record<FieldType, (field: Field, options: Options) => string> = {
         Array: renderArray,
         Boolean: renderBoolean,
         Date: renderSymbol,
@@ -45,7 +47,7 @@ function renderContentTypeFields(fields: Field[]): string {
         Text: renderSymbol,
       }
 
-      return renderField(field, functionMap[field.type](field))
+      return renderField(field, functionMap[field.type](field, options), options)
     })
     .join("\n\n")
 }

src/renderers/contentful/fields/renderArray.ts

@@ -2,8 +2,9 @@ import { Field } from "contentful"
 import renderSymbol from "./renderSymbol"
 import renderLink from "./renderLink"
 import renderArrayOf from "../../typescript/renderArrayOf"
+import { Options } from "../../render"
 
-export default function renderArray(field: Field): string {
+export default function renderArray(field: Field, options: Options): string {
   if (!field.items) {
     throw new Error(`Cannot render non-array field ${field.id} as an array`)
   }
@@ -20,9 +21,7 @@ export default function renderArray(field: Field): string {
     }
 
     case "Link": {
-      return renderArrayOf(renderLink(fieldWithValidations))
+      return renderArrayOf(renderLink(fieldWithValidations, options))
     }
   }
-
-  return renderArrayOf("unknown")
 }

src/renderers/contentful/fields/renderLink.ts

@@ -1,8 +1,9 @@
 import { Field } from "contentful"
 import renderContentTypeId from "../renderContentTypeId"
 import { renderUnionValues } from "../../typescript/renderUnion"
+import { Options } from "../../render"
 
-export default function renderLink(field: Field): string {
+export default function renderLink(field: Field, options: Options): string {
   if (field.linkType === "Asset") {
     return "Asset"
   }
@@ -11,7 +12,9 @@ export default function renderLink(field: Field): string {
     const contentTypeValidation = field.validations.find(validation => !!validation.linkContentType)
 
     if (contentTypeValidation) {
-      return renderUnionValues(contentTypeValidation.linkContentType!.map(renderContentTypeId))
+      return renderUnionValues(
+        contentTypeValidation.linkContentType!.map(link => renderContentTypeId(link, options)),
+      )
     } else {
       return "Entry<{ [fieldId: string]: unknown }>"
     }

src/renderers/contentful/renderContentType.ts

@@ -1,5 +1,7 @@
 import { ContentType, Field, FieldType, Sys } from "contentful"
 
+import { Options } from "../render"
+
 import renderInterface from "../typescript/renderInterface"
 import renderField from "./renderField"
 import renderContentTypeId from "./renderContentTypeId"
@@ -13,9 +15,9 @@ import renderObject from "./fields/renderObject"
 import renderRichText from "./fields/renderRichText"
 import renderSymbol from "./fields/renderSymbol"
 
-export default function renderContentType(contentType: ContentType, localization: boolean): string {
-  const name = renderContentTypeId(contentType.sys.id)
-  const fields = renderContentTypeFields(contentType.fields, localization)
+export default function renderContentType(contentType: ContentType, options: Options): string {
+  const name = renderContentTypeId(contentType.sys.id, options)
+  const fields = renderContentTypeFields(contentType.fields, options)
   const sys = renderSys(contentType.sys)
 
   return `
@@ -34,11 +36,11 @@ function descriptionComment(description: string | undefined) {
   return ""
 }
 
-function renderContentTypeFields(fields: Field[], localization: boolean): string {
+function renderContentTypeFields(fields: Field[], options: Options): string {
   return fields
     .filter(field => !field.omitted)
     .map<string>(field => {
-      const functionMap: Record<FieldType, (field: Field) => string> = {
+      const functionMap: Record<FieldType, (field: Field, options: Options) => string> = {
         Array: renderArray,
         Boolean: renderBoolean,
         Date: renderSymbol,
@@ -52,7 +54,7 @@ function renderContentTypeFields(fields: Field[], localization: boolean): string
         Text: renderSymbol,
       }
 
-      return renderField(field, functionMap[field.type](field), localization)
+      return renderField(field, functionMap[field.type](field, options), options)
     })
     .join("\n\n")
 }

src/renderers/contentful/renderContentTypeId.ts

@@ -1,5 +1,13 @@
 import { upperFirst, camelCase } from "lodash"
+import { Options } from "../render"
 
-export default function renderContentTypeId(contentTypeId: string): string {
-  return "I" + upperFirst(camelCase(contentTypeId))
+export default function renderContentTypeId(contentTypeId: string, options: Options): string {
+  let str = upperFirst(camelCase(contentTypeId))
+
+  if (options.prefix === undefined) options.prefix = "I"
+
+  if (options.prefix) str = options.prefix + str
+  if (options.suffix) str = str + options.suffix
+
+  return str
 }

src/renderers/contentful/renderField.ts

@@ -1,10 +1,7 @@
 import { Field } from "contentful"
 import renderInterfaceProperty from "../typescript/renderInterfaceProperty"
+import { Options } from "../render"
 
-export default function renderField(
-  field: Field,
-  type: string,
-  localization: boolean = false,
-): string {
-  return renderInterfaceProperty(field.id, type, field.required, localization, field.name)
+export default function renderField(field: Field, type: string, options: Options): string {
+  return renderInterfaceProperty(field.id, type, field.required, options.localization, field.name)
 }

src/renderers/render.ts

@@ -10,21 +10,26 @@ import renderDefaultLocale from "./contentful/renderDefaultLocale"
 import renderNamespace from "./contentful/renderNamespace"
 import renderLocalizedTypes from "./contentful/renderLocalizedTypes"
 
-interface Options {
+export interface Options {
   localization?: boolean
   namespace?: string
+  prefix?: string
+  suffix?: string
 }
 
+export const defaultOptions: Options = {}
+
 export default async function render(
   contentTypes: ContentType[],
   locales: Locale[],
-  { namespace, localization = false }: Options = {},
+  options: Options,
 ) {
+  const { namespace, localization = false } = options
   const sortedContentTypes = contentTypes.sort((a, b) => a.sys.id.localeCompare(b.sys.id))
   const sortedLocales = locales.sort((a, b) => a.code.localeCompare(b.code))
 
   const typingsSource = [
-    renderAllContentTypes(sortedContentTypes, localization),
+    renderAllContentTypes(sortedContentTypes, options),
     renderAllContentTypeIds(sortedContentTypes),
     renderAllLocales(sortedLocales),
     renderDefaultLocale(sortedLocales),
@@ -40,8 +45,8 @@ export default async function render(
   return format(source, { ...prettierConfig, parser: "typescript" })
 }
 
-function renderAllContentTypes(contentTypes: ContentType[], localization: boolean): string {
-  return contentTypes.map(contentType => renderContentType(contentType, localization)).join("\n\n")
+function renderAllContentTypes(contentTypes: ContentType[], options: Options): string {
+  return contentTypes.map(contentType => renderContentType(contentType, options)).join("\n\n")
 }
 
 function renderAllContentTypeIds(contentTypes: ContentType[]): string {

src/renderers/renderFieldsOnly.ts

@@ -5,24 +5,23 @@ import { format, resolveConfig } from "prettier"
 import renderContentType from "./contentful-fields-only/renderContentType"
 import renderNamespace from "./contentful/renderNamespace"
 
-interface Options {
+export interface Options {
   namespace?: string
+  prefix?: string
+  suffix?: string
 }
 
-export default async function renderFieldsOnly(
-  contentTypes: ContentType[],
-  { namespace }: Options = {},
-) {
+export default async function renderFieldsOnly(contentTypes: ContentType[], options: Options) {
   const sortedContentTypes = contentTypes.sort((a, b) => a.sys.id.localeCompare(b.sys.id))
 
-  const typingsSource = renderAllContentTypes(sortedContentTypes)
-  const source = [renderNamespace(typingsSource, namespace)].join("\n\n")
+  const typingsSource = renderAllContentTypes(sortedContentTypes, options)
+  const source = [renderNamespace(typingsSource, options.namespace)].join("\n\n")
 
   const prettierConfig = await resolveConfig(process.cwd())
 
   return format(source, { ...prettierConfig, parser: "typescript" })
 }
 
-function renderAllContentTypes(contentTypes: ContentType[]): string {
-  return contentTypes.map(contentType => renderContentType(contentType)).join("\n\n")
+function renderAllContentTypes(contentTypes: ContentType[], options: Options): string {
+  return contentTypes.map(contentType => renderContentType(contentType, options)).join("\n\n")
 }

src/renderers/typescript/renderInterfaceProperty.ts

@@ -2,7 +2,7 @@ export default function renderInterfaceProperty(
   name: string,
   type: string,
   required: boolean,
-  localization: boolean,
+  localization?: boolean,
   description?: string,
 ): string {
   return [