Add --link-type option

src/contentful-typescript-codegen.ts

@@ -20,6 +20,7 @@ const cli = meow(
                        Assets, or Rich Text. This is useful for ensuring raw
                        Contentful responses will be compatible with your code.
     --localization -l  Output fields with localized values
+    --link-type        Output links wrapped in this type, eg LinkType<Entry<...>>
 
   Examples
     $ contentful-typescript-codegen -o src/@types/generated/contentful.d.ts
@@ -35,6 +36,10 @@ const cli = meow(
         type: "boolean",
         isRequired: false,
       },
+      linkType: {
+        type: "string",
+        isRequired: false,
+      },
       poll: {
         type: "boolean",
         alias: "p",
@@ -74,6 +79,7 @@ async function runCodegen(outputFile: string) {
     output = await render(contentTypes.items, locales.items, {
       localization: cli.flags.localization,
       namespace: cli.flags.namespace,
+      linkType: cli.flags.linkType,
     })
   }
 

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 { ContentfulRenderOptions } from "../options"
 
-export default function renderArray(field: Field): string {
+export default function renderArray(field: Field, options: ContentfulRenderOptions): string {
   if (!field.items) {
     throw new Error(`Cannot render non-array field ${field.id} as an array`)
   }
@@ -20,7 +21,7 @@ export default function renderArray(field: Field): string {
     }
 
     case "Link": {
-      return renderArrayOf(renderLink(fieldWithValidations))
+      return renderArrayOf(renderLink(fieldWithValidations, options))
     }
   }
 

src/renderers/contentful/fields/renderLink.ts

@@ -1,8 +1,14 @@
 import { Field } from "contentful"
 import renderContentTypeId from "../renderContentTypeId"
 import { renderUnionValues } from "../../typescript/renderUnion"
+import { ContentfulRenderOptions } from "../options"
 
-export default function renderLink(field: Field): string {
+export default function renderLink(field: Field, { linkType }: ContentfulRenderOptions): string {
+  const baseType = renderLinkBaseType(field)
+  return linkType === undefined ? baseType : `${linkType}<${baseType}>`
+}
+
+function renderLinkBaseType(field: Field): string {
   if (field.linkType === "Asset") {
     return "Asset"
   }

src/renderers/contentful/options.ts

@@ -0,0 +1,6 @@
+export interface ContentfulRenderOptions {
+  localization?: boolean
+  linkType?: string
+}
+
+export const DEFAULT_RENDER_OPTIONS: ContentfulRenderOptions = {}

src/renderers/contentful/renderContentType.ts

@@ -12,10 +12,14 @@ import renderNumber from "./fields/renderNumber"
 import renderObject from "./fields/renderObject"
 import renderRichText from "./fields/renderRichText"
 import renderSymbol from "./fields/renderSymbol"
+import { ContentfulRenderOptions } from "./options"
 
-export default function renderContentType(contentType: ContentType, localization: boolean): string {
+export default function renderContentType(
+  contentType: ContentType,
+  options: ContentfulRenderOptions,
+): string {
   const name = renderContentTypeId(contentType.sys.id)
-  const fields = renderContentTypeFields(contentType.fields, localization)
+  const fields = renderContentTypeFields(contentType.fields, options)
   const sys = renderSys(contentType.sys)
 
   return `
@@ -34,11 +38,14 @@ function descriptionComment(description: string | undefined) {
   return ""
 }
 
-function renderContentTypeFields(fields: Field[], localization: boolean): string {
+function renderContentTypeFields(fields: Field[], options: ContentfulRenderOptions): string {
   return fields
     .filter(field => !field.omitted)
     .map<string>(field => {
-      const functionMap: Record<FieldType, (field: Field) => string> = {
+      const functionMap: Record<
+        FieldType,
+        (field: Field, options: ContentfulRenderOptions) => string
+      > = {
         Array: renderArray,
         Boolean: renderBoolean,
         Date: renderSymbol,
@@ -52,7 +59,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.localization)
     })
     .join("\n\n")
 }

src/renderers/contentful/renderContentfulImports.ts

@@ -1,4 +1,6 @@
-export default function renderContentfulImports(localization: boolean = false): string {
+import { DEFAULT_RENDER_OPTIONS } from "./options"
+
+export default function renderContentfulImports({ localization } = DEFAULT_RENDER_OPTIONS): string {
   if (localization) {
     return `
     // THIS FILE IS AUTOMATICALLY GENERATED. DO NOT MODIFY IT.

src/renderers/render.ts

@@ -9,39 +9,44 @@ import renderAllLocales from "./contentful/renderAllLocales"
 import renderDefaultLocale from "./contentful/renderDefaultLocale"
 import renderNamespace from "./contentful/renderNamespace"
 import renderLocalizedTypes from "./contentful/renderLocalizedTypes"
+import { ContentfulRenderOptions } from "./contentful/options"
 
 interface Options {
   localization?: boolean
   namespace?: string
+  linkType?: string
 }
 
 export default async function render(
   contentTypes: ContentType[],
   locales: Locale[],
-  { namespace, localization = false }: Options = {},
+  { namespace, linkType, localization = false }: Options = {},
 ) {
+  const options = { linkType, localization }
   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, { linkType, localization }),
     renderAllContentTypeIds(sortedContentTypes),
     renderAllLocales(sortedLocales),
     renderDefaultLocale(sortedLocales),
     renderLocalizedTypes(localization),
   ].join("\n\n")
 
-  const source = [
-    renderContentfulImports(localization),
-    renderNamespace(typingsSource, namespace),
-  ].join("\n\n")
+  const source = [renderContentfulImports(options), renderNamespace(typingsSource, namespace)].join(
+    "\n\n",
+  )
 
   const prettierConfig = await resolveConfig(process.cwd())
   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: ContentfulRenderOptions,
+): string {
+  return contentTypes.map(contentType => renderContentType(contentType, options)).join("\n\n")
 }
 
 function renderAllContentTypeIds(contentTypes: ContentType[]): string {