-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into feat/named-imports
- Loading branch information
Showing
7 changed files
with
533 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,166 @@ | ||
| import { Field } from 'contentful'; | ||
| import { ContentTypeProps } from 'contentful-management'; | ||
| import { JSDocStructure, JSDocTagStructure, OptionalKind, SourceFile } from 'ts-morph'; | ||
| import { CFContentType } from '../../types'; | ||
| import { BaseContentTypeRenderer } from './base-content-type-renderer'; | ||
|
|
||
| type EntryDocsOptionsProps = { | ||
| /* Name of generated Entry type */ | ||
| readonly name: string; | ||
| readonly contentType: CFContentType; | ||
| }; | ||
|
|
||
| type FieldsDocsOptionsProps = { | ||
| /* Name of generated Fields type */ | ||
| readonly name: string; | ||
| readonly entryName: string; | ||
| readonly fields: Field[]; | ||
| }; | ||
|
|
||
| type FieldDocsOptionsProps = { | ||
| readonly field: Field; | ||
| }; | ||
|
|
||
| export type JSDocRenderOptions = { | ||
| renderEntryDocs?: (props: EntryDocsOptionsProps) => OptionalKind<JSDocStructure> | string; | ||
| renderFieldsDocs?: (props: FieldsDocsOptionsProps) => OptionalKind<JSDocStructure> | string; | ||
| renderFieldDocs?: (props: FieldDocsOptionsProps) => OptionalKind<JSDocStructure> | string; | ||
| }; | ||
|
|
||
| export const defaultJsDocRenderOptions: Required<JSDocRenderOptions> = { | ||
| renderEntryDocs: ({ contentType, name }) => { | ||
| const tags: OptionalKind<JSDocTagStructure>[] = []; | ||
|
|
||
| tags.push( | ||
| { | ||
| tagName: 'name', | ||
| text: name, | ||
| }, | ||
| { | ||
| tagName: 'type', | ||
| text: `{${name}}`, | ||
| }, | ||
| ); | ||
|
|
||
| const cmaContentType = contentType as ContentTypeProps; | ||
|
|
||
| if (cmaContentType.sys.createdBy?.sys?.id) { | ||
| tags.push({ | ||
| tagName: 'author', | ||
| text: cmaContentType.sys.createdBy.sys.id, | ||
| }); | ||
| } | ||
|
|
||
| if (cmaContentType.sys.firstPublishedAt) { | ||
| tags.push({ | ||
| tagName: 'since', | ||
| text: cmaContentType.sys.firstPublishedAt, | ||
| }); | ||
| } | ||
|
|
||
| if (cmaContentType.sys.publishedVersion) { | ||
| tags.push({ | ||
| tagName: 'version', | ||
| text: cmaContentType.sys.publishedVersion.toString(), | ||
| }); | ||
| } | ||
|
|
||
| return { | ||
| description: `Entry type definition for content type '${contentType.sys.id}' (${contentType.name})`, | ||
| tags, | ||
| }; | ||
| }, | ||
|
|
||
| renderFieldsDocs: ({ name, entryName }) => { | ||
| return { | ||
| description: `Fields type definition for content type '${entryName}'`, | ||
| tags: [ | ||
| { | ||
| tagName: 'name', | ||
| text: name, | ||
| }, | ||
| { | ||
| tagName: 'type', | ||
| text: `{${name}}`, | ||
| }, | ||
| { | ||
| tagName: 'memberof', | ||
| text: entryName, | ||
| }, | ||
| ], | ||
| }; | ||
| }, | ||
|
|
||
| renderFieldDocs: ({ field }) => { | ||
| return { | ||
| description: `Field type definition for field '${field.id}' (${field.name})`, | ||
| tags: [ | ||
| { | ||
| tagName: 'name', | ||
| text: field.name, | ||
| }, | ||
| { | ||
| tagName: 'localized', | ||
| text: field.localized.toString(), | ||
| }, | ||
| ], | ||
| }; | ||
| }, | ||
| }; | ||
|
|
||
| /* JsDocRenderer only works in conjunction with other Renderers. It relays on previously rendered Interfaces */ | ||
| export class JsDocRenderer extends BaseContentTypeRenderer { | ||
| private renderOptions: Required<JSDocRenderOptions>; | ||
|
|
||
| constructor({ renderOptions }: { renderOptions?: JSDocRenderOptions } = {}) { | ||
| super(); | ||
| this.renderOptions = { | ||
| ...defaultJsDocRenderOptions, | ||
| ...renderOptions, | ||
| }; | ||
| } | ||
|
|
||
| public render = (contentType: CFContentType, file: SourceFile): void => { | ||
| const context = this.createContext(); | ||
|
|
||
| const entryInterfaceName = context.moduleName(contentType.sys.id); | ||
| const entryInterface = file.getTypeAlias(entryInterfaceName); | ||
|
|
||
| if (entryInterface) { | ||
| entryInterface.addJsDoc( | ||
| this.renderOptions.renderEntryDocs({ | ||
| name: entryInterfaceName, | ||
| contentType, | ||
| }), | ||
| ); | ||
| } | ||
|
|
||
| const fieldsInterfaceName = context.moduleFieldsName(contentType.sys.id); | ||
| const fieldsInterface = file.getInterface(fieldsInterfaceName); | ||
|
|
||
| if (fieldsInterface) { | ||
| fieldsInterface.addJsDoc( | ||
| this.renderOptions.renderFieldsDocs({ | ||
| name: fieldsInterfaceName, | ||
| entryName: entryInterfaceName, | ||
| fields: contentType.fields, | ||
| }), | ||
| ); | ||
|
|
||
| const fields = fieldsInterface.getProperties(); | ||
|
|
||
| for (const field of fields) { | ||
| const fieldName = field.getName(); | ||
| const contentTypeField = contentType.fields.find((f) => f.id === fieldName); | ||
|
|
||
| if (contentTypeField) { | ||
| field.addJsDoc( | ||
| this.renderOptions.renderFieldDocs({ | ||
| field: contentTypeField, | ||
| }), | ||
| ); | ||
| } | ||
| } | ||
| } | ||
| }; | ||
| } |
Oops, something went wrong.