From db3b100f794e281c6dd6202cf7d5ec2c2bd726fa Mon Sep 17 00:00:00 2001 From: Iddan Aaronsohn Date: Fri, 21 May 2021 18:24:39 +0300 Subject: [PATCH 1/4] Add JSDoc documentation regarding docPropagation --- README.md | 2 +- src/generator/gentime/settingsSingleton.ts | 15 ++++++++++++--- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9ddf8b5fd..dd0abf11e 100644 --- a/README.md +++ b/README.md @@ -649,7 +649,7 @@ You are able to control certain aspects of the Nexus Prisma code generation. ##### `docPropagation.JSDoc: boolean` -- **`@summary`** Should Prisma Schema docs propagate as JSdoc? +- **`@summary`** Should Prisma Schema docs propagate as JSDoc? - **`@default`** `true` ##### `docPropagation.GraphQLDocs: boolean` diff --git a/src/generator/gentime/settingsSingleton.ts b/src/generator/gentime/settingsSingleton.ts index 497c88b9f..068094664 100644 --- a/src/generator/gentime/settingsSingleton.ts +++ b/src/generator/gentime/settingsSingleton.ts @@ -7,17 +7,26 @@ export namespace Gentime { */ projectIdIntToGraphQL?: 'ID' | 'Int' /** - * TODO + * Should Prisma Schema docs propagate as docs? + * + * @default `true` */ docPropagation?: | boolean | { /** - * TODO + * Should Prisma Schema docs propagate as JSDoc? + * + * @default `true` */ JSDoc?: boolean /** - * TODO + * Should Prisma Schema docs propagate as GraphQL docs? + * + * @remarks When this is disabled it will force `.description` property to be `undefined`. This + * is for convenience, allowing you to avoid post-generation data manipulation or + * consumption contortions. + * @default `true` */ GraphQLDocs?: boolean } From 40ff55716f79469cdfc5ca2c7cb53f177a785084 Mon Sep 17 00:00:00 2001 From: Iddan Aaronsohn Date: Sun, 23 May 2021 01:57:44 +0300 Subject: [PATCH 2/4] Update src/generator/gentime/settingsSingleton.ts Co-authored-by: Jason Kuhrt --- src/generator/gentime/settingsSingleton.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/generator/gentime/settingsSingleton.ts b/src/generator/gentime/settingsSingleton.ts index 068094664..0cca1ad13 100644 --- a/src/generator/gentime/settingsSingleton.ts +++ b/src/generator/gentime/settingsSingleton.ts @@ -9,7 +9,7 @@ export namespace Gentime { /** * Should Prisma Schema docs propagate as docs? * - * @default `true` + * @default true */ docPropagation?: | boolean From cc86404d266e02329d57db47d3a6a9aa59d1ca09 Mon Sep 17 00:00:00 2001 From: Jason Kuhrt Date: Tue, 25 May 2021 17:27:46 -0400 Subject: [PATCH 3/4] Update src/generator/gentime/settingsSingleton.ts --- src/generator/gentime/settingsSingleton.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/src/generator/gentime/settingsSingleton.ts b/src/generator/gentime/settingsSingleton.ts index 0cca1ad13..dd9a564fe 100644 --- a/src/generator/gentime/settingsSingleton.ts +++ b/src/generator/gentime/settingsSingleton.ts @@ -6,6 +6,7 @@ export namespace Gentime { * TODO */ projectIdIntToGraphQL?: 'ID' | 'Int' + // TODO add some examples /** * Should Prisma Schema docs propagate as docs? * From 59e08b6036da1b61fd234ea11ce682944941a253 Mon Sep 17 00:00:00 2001 From: Jason Kuhrt Date: Tue, 25 May 2021 17:28:30 -0400 Subject: [PATCH 4/4] Apply suggestions from code review --- src/generator/gentime/settingsSingleton.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/generator/gentime/settingsSingleton.ts b/src/generator/gentime/settingsSingleton.ts index dd9a564fe..f149ccec0 100644 --- a/src/generator/gentime/settingsSingleton.ts +++ b/src/generator/gentime/settingsSingleton.ts @@ -18,7 +18,7 @@ export namespace Gentime { /** * Should Prisma Schema docs propagate as JSDoc? * - * @default `true` + * @default true */ JSDoc?: boolean /** @@ -27,7 +27,7 @@ export namespace Gentime { * @remarks When this is disabled it will force `.description` property to be `undefined`. This * is for convenience, allowing you to avoid post-generation data manipulation or * consumption contortions. - * @default `true` + * @default true */ GraphQLDocs?: boolean }