From 8db13ede499139f1ad4136a85c8dc12ab36f8940 Mon Sep 17 00:00:00 2001 From: Jason Kuhrt Date: Wed, 23 Jun 2021 13:24:19 -0400 Subject: [PATCH 1/2] docs: list enum members in jsdoc closes #67 --- src/generator/helpers/JSDocTemplates.ts | 4 +++- .../__snapshots__/enum.test.ts.snap | 16 ++++++++++++---- .../__snapshots__/enumDoc.test.ts.snap | 16 ++++++++++++---- 3 files changed, 27 insertions(+), 9 deletions(-) diff --git a/src/generator/helpers/JSDocTemplates.ts b/src/generator/helpers/JSDocTemplates.ts index 322df73cf..f1d830a0f 100644 --- a/src/generator/helpers/JSDocTemplates.ts +++ b/src/generator/helpers/JSDocTemplates.ts @@ -28,7 +28,9 @@ export function jsDocForEnum(enum_: DMMF.DatamodelEnum): JSDoc { function enumIntro(enum_: DMMF.DatamodelEnum): string { return dedent` - * Nexus \`enumType\` configuration based on the \`${enum_.name}\` enum in your Prisma schema. + * Nexus \`enumType\` configuration based on your Prisma schema's \`${enum_.name}\` enum. + * + * Has the following members: ${enum_.values.map((value) => value.name).join(', ')} ` } diff --git a/tests/unit/typescriptDeclarationFile/__snapshots__/enum.test.ts.snap b/tests/unit/typescriptDeclarationFile/__snapshots__/enum.test.ts.snap index 741922292..87a5262d8 100644 --- a/tests/unit/typescriptDeclarationFile/__snapshots__/enum.test.ts.snap +++ b/tests/unit/typescriptDeclarationFile/__snapshots__/enum.test.ts.snap @@ -21,7 +21,9 @@ declare namespace $Types { // Enums /** - * Nexus \`enumType\` configuration based on the \`Foo\` enum in your Prisma schema. + * Nexus \`enumType\` configuration based on your Prisma schema's \`Foo\` enum. + * + * Has the following members: a * * ### ️⚠️ Missing Documentation for this Enum * @@ -83,7 +85,9 @@ declare namespace $Types { // /** - * Nexus \`enumType\` configuration based on the \`Foo\` enum in your Prisma schema. + * Nexus \`enumType\` configuration based on your Prisma schema's \`Foo\` enum. + * + * Has the following members: a * * ### ️⚠️ Missing Documentation for this Enum * @@ -174,7 +178,9 @@ declare namespace $Types { // Enums /** - * Nexus \`enumType\` configuration based on the \`Foo\` enum in your Prisma schema. + * Nexus \`enumType\` configuration based on your Prisma schema's \`Foo\` enum. + * + * Has the following members: a * * Some documentation * @@ -223,7 +229,9 @@ declare namespace $Types { // /** - * Nexus \`enumType\` configuration based on the \`Foo\` enum in your Prisma schema. + * Nexus \`enumType\` configuration based on your Prisma schema's \`Foo\` enum. + * + * Has the following members: a * * Some documentation * diff --git a/tests/unit/typescriptDeclarationFile/__snapshots__/enumDoc.test.ts.snap b/tests/unit/typescriptDeclarationFile/__snapshots__/enumDoc.test.ts.snap index 5b9f3703a..5a356542b 100644 --- a/tests/unit/typescriptDeclarationFile/__snapshots__/enumDoc.test.ts.snap +++ b/tests/unit/typescriptDeclarationFile/__snapshots__/enumDoc.test.ts.snap @@ -21,7 +21,9 @@ declare namespace $Types { // Enums /** - * Nexus \`enumType\` configuration based on the \`Foo\` enum in your Prisma schema. + * Nexus \`enumType\` configuration based on your Prisma schema's \`Foo\` enum. + * + * Has the following members: a * * Some documentation * @@ -70,7 +72,9 @@ declare namespace $Types { // /** - * Nexus \`enumType\` configuration based on the \`Foo\` enum in your Prisma schema. + * Nexus \`enumType\` configuration based on your Prisma schema's \`Foo\` enum. + * + * Has the following members: a * * Some documentation * @@ -148,7 +152,9 @@ declare namespace $Types { // Enums /** - * Nexus \`enumType\` configuration based on the \`Foo\` enum in your Prisma schema. + * Nexus \`enumType\` configuration based on your Prisma schema's \`Foo\` enum. + * + * Has the following members: a * * ### ️⚠️ Missing Documentation for this Enum * @@ -210,7 +216,9 @@ declare namespace $Types { // /** - * Nexus \`enumType\` configuration based on the \`Foo\` enum in your Prisma schema. + * Nexus \`enumType\` configuration based on your Prisma schema's \`Foo\` enum. + * + * Has the following members: a * * ### ️⚠️ Missing Documentation for this Enum * From c631fe188fbc56bcad19e43a5da8184136ea0078 Mon Sep 17 00:00:00 2001 From: Jason Kuhrt Date: Wed, 23 Jun 2021 13:53:37 -0400 Subject: [PATCH 2/2] improve jsdoc --- README.md | 7 +- src/generator/helpers/JSDocTemplates.ts | 36 ++- .../__snapshots__/enum.test.ts.snap | 40 +-- .../__snapshots__/enumDoc.test.ts.snap | 40 +-- .../modelDocumentation.test.ts.snap | 96 +++--- .../modelRelationFields.test.ts.snap | 90 +++--- .../modelScalarFields.test.ts.snap | 300 +++++++++--------- 7 files changed, 310 insertions(+), 299 deletions(-) diff --git a/README.md b/README.md index 8aeef3430..01e7735d3 100644 --- a/README.md +++ b/README.md @@ -761,6 +761,8 @@ type User { #### As JSDoc +Can be disabled in [gentime settings](https://pris.ly/nexus-prisma/docs/settings/gentime). + ```prisma /// A user. model User { @@ -780,9 +782,10 @@ User.id // JSDoc: A stable identifier to find users by. These are finer points that aren't perhaps worth a top-level point but none the less add up toward a thoughtful developer experience. -##### Default JSDoc +##### JSDoc -Fields and models that you do not document will result in a helpful default JSDoc that teaches you about this. +- Generated Nexus configuration for fields and models that you _have not_ documented in your PSL get default JSDoc that teaches you how to do so. +- JSDoc for Enums have their members embedded ##### Default Runtime diff --git a/src/generator/helpers/JSDocTemplates.ts b/src/generator/helpers/JSDocTemplates.ts index f1d830a0f..137a18d4b 100644 --- a/src/generator/helpers/JSDocTemplates.ts +++ b/src/generator/helpers/JSDocTemplates.ts @@ -1,6 +1,5 @@ import { DMMF } from '@prisma/client/runtime' import dedent from 'dindist' -import { upperFirst } from 'lodash' type JSDoc = string @@ -21,6 +20,8 @@ export function jsDocForEnum(enum_: DMMF.DatamodelEnum): JSDoc { * ${enumDoc} * + * Contains these members: ${enum_.values.map((value) => value.name).join(', ')} + * ${enumExample(enum_)} */ ` @@ -28,9 +29,7 @@ export function jsDocForEnum(enum_: DMMF.DatamodelEnum): JSDoc { function enumIntro(enum_: DMMF.DatamodelEnum): string { return dedent` - * Nexus \`enumType\` configuration based on your Prisma schema's \`${enum_.name}\` enum. - * - * Has the following members: ${enum_.values.map((value) => value.name).join(', ')} + * Generated Nexus \`enumType\` configuration based on your Prisma schema's enum \`${enum_.name}\`. ` } @@ -47,7 +46,7 @@ function enumExample(enum_: DMMF.DatamodelEnum): string { function enumMissingDoc(enum_: DMMF.DatamodelEnum): string { return dedent` - ${missingDocsIntro('enum')} + ${missingDocsIntro({ kind: 'enum', enum: enum_ })} * * \`\`\`prisma * /// Lorem ipsum dolor sit amet... @@ -79,7 +78,7 @@ export function jsDocForModel(model: DMMF.Model): JSDoc { function modelIntro(model: DMMF.Model): string { return dedent` - * Nexus \`objectType\` related configuration based on the \`${model.name}\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`${model.name}\`. ` } @@ -87,7 +86,7 @@ function modelMissingDoc(model: DMMF.Model): string { // TODO once https://stackoverflow.com/questions/61893953/how-to-escape-symbol-in-jsdoc-for-vscode // is resolved then we can write better examples below like: id String @id return dedent` - ${missingDocsIntro('model')} + ${missingDocsIntro({ kind: 'model', model })} * * \`\`\`prisma * /// Lorem ipsum dolor sit amet... @@ -136,13 +135,13 @@ export function jsDocForField({ field, model }: FieldModelParams): JSDoc { function fieldIntro({ model, field }: FieldModelParams): string { return dedent` - * Nexus \`t.field\` related configuration based on the \`${model.name}.${field.name}\` field in your Prisma schema. + * Generated Nexus \`t.field\` configuration based on your Prisma schema's model-field \`${model.name}.${field.name}\`. ` } function fieldMissingDoc({ model, field }: FieldModelParams): string { return dedent` - ${missingDocsIntro('model')} + ${missingDocsIntro({ kind: 'model', model })} * \`\`\`prisma * model ${model.name} { * /// Lorem ipsum dolor sit amet. @@ -175,14 +174,23 @@ function fieldExample({ model, field }: FieldModelParams): string { * Helpers */ -function missingDocsIntro(kind: 'model' | 'enum' | 'field'): string { +function missingDocsIntro( + info: { kind: 'model'; model: DMMF.Model } | { kind: 'enum'; enum: DMMF.DatamodelEnum } | { kind: 'field' } +): string { + const thisItem = + info.kind === 'enum' + ? `enum ${info.enum.name}` + : info.kind === 'model' + ? `model ${info.model.name}` + : info.kind + return dedent` - * ### ️⚠️ Missing Documentation for this ${upperFirst(kind)} + * ### ️⚠️ You have not writen documentation for ${thisItem} * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about ${thisItem} + * by documenting it in your Prisma schema. For example: * ` } -const missingDocsOutro = `* Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments).` +const missingDocsOutro = `* Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments).` diff --git a/tests/unit/typescriptDeclarationFile/__snapshots__/enum.test.ts.snap b/tests/unit/typescriptDeclarationFile/__snapshots__/enum.test.ts.snap index 87a5262d8..de0daae3c 100644 --- a/tests/unit/typescriptDeclarationFile/__snapshots__/enum.test.ts.snap +++ b/tests/unit/typescriptDeclarationFile/__snapshots__/enum.test.ts.snap @@ -21,14 +21,12 @@ declare namespace $Types { // Enums /** - * Nexus \`enumType\` configuration based on your Prisma schema's \`Foo\` enum. + * Generated Nexus \`enumType\` configuration based on your Prisma schema's enum \`Foo\`. * - * Has the following members: a - * - * ### ️⚠️ Missing Documentation for this Enum + * ### ️⚠️ You have not writen documentation for enum Foo * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about enum Foo + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -38,7 +36,9 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * + * Contains these members: a * * @example * @@ -85,14 +85,12 @@ declare namespace $Types { // /** - * Nexus \`enumType\` configuration based on your Prisma schema's \`Foo\` enum. + * Generated Nexus \`enumType\` configuration based on your Prisma schema's enum \`Foo\`. * - * Has the following members: a - * - * ### ️⚠️ Missing Documentation for this Enum + * ### ️⚠️ You have not writen documentation for enum Foo * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about enum Foo + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -102,7 +100,9 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * + * Contains these members: a * * @example * @@ -178,12 +178,12 @@ declare namespace $Types { // Enums /** - * Nexus \`enumType\` configuration based on your Prisma schema's \`Foo\` enum. - * - * Has the following members: a + * Generated Nexus \`enumType\` configuration based on your Prisma schema's enum \`Foo\`. * * Some documentation * + * Contains these members: a + * * @example * * import { enumType } from 'nexus' @@ -229,12 +229,12 @@ declare namespace $Types { // /** - * Nexus \`enumType\` configuration based on your Prisma schema's \`Foo\` enum. - * - * Has the following members: a + * Generated Nexus \`enumType\` configuration based on your Prisma schema's enum \`Foo\`. * * Some documentation * + * Contains these members: a + * * @example * * import { enumType } from 'nexus' diff --git a/tests/unit/typescriptDeclarationFile/__snapshots__/enumDoc.test.ts.snap b/tests/unit/typescriptDeclarationFile/__snapshots__/enumDoc.test.ts.snap index 5a356542b..61a32c3a4 100644 --- a/tests/unit/typescriptDeclarationFile/__snapshots__/enumDoc.test.ts.snap +++ b/tests/unit/typescriptDeclarationFile/__snapshots__/enumDoc.test.ts.snap @@ -21,12 +21,12 @@ declare namespace $Types { // Enums /** - * Nexus \`enumType\` configuration based on your Prisma schema's \`Foo\` enum. - * - * Has the following members: a + * Generated Nexus \`enumType\` configuration based on your Prisma schema's enum \`Foo\`. * * Some documentation * + * Contains these members: a + * * @example * * import { enumType } from 'nexus' @@ -72,12 +72,12 @@ declare namespace $Types { // /** - * Nexus \`enumType\` configuration based on your Prisma schema's \`Foo\` enum. - * - * Has the following members: a + * Generated Nexus \`enumType\` configuration based on your Prisma schema's enum \`Foo\`. * * Some documentation * + * Contains these members: a + * * @example * * import { enumType } from 'nexus' @@ -152,14 +152,12 @@ declare namespace $Types { // Enums /** - * Nexus \`enumType\` configuration based on your Prisma schema's \`Foo\` enum. + * Generated Nexus \`enumType\` configuration based on your Prisma schema's enum \`Foo\`. * - * Has the following members: a - * - * ### ️⚠️ Missing Documentation for this Enum + * ### ️⚠️ You have not writen documentation for enum Foo * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about enum Foo + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -169,7 +167,9 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * + * Contains these members: a * * @example * @@ -216,14 +216,12 @@ declare namespace $Types { // /** - * Nexus \`enumType\` configuration based on your Prisma schema's \`Foo\` enum. + * Generated Nexus \`enumType\` configuration based on your Prisma schema's enum \`Foo\`. * - * Has the following members: a - * - * ### ️⚠️ Missing Documentation for this Enum + * ### ️⚠️ You have not writen documentation for enum Foo * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about enum Foo + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -233,7 +231,9 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * + * Contains these members: a * * @example * diff --git a/tests/unit/typescriptDeclarationFile/__snapshots__/modelDocumentation.test.ts.snap b/tests/unit/typescriptDeclarationFile/__snapshots__/modelDocumentation.test.ts.snap index decc74645..3cdd5a85d 100644 --- a/tests/unit/typescriptDeclarationFile/__snapshots__/modelDocumentation.test.ts.snap +++ b/tests/unit/typescriptDeclarationFile/__snapshots__/modelDocumentation.test.ts.snap @@ -17,12 +17,12 @@ declare namespace $Types { // Models /** - * Nexus \`objectType\` related configuration based on the \`SomeModel\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`SomeModel\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -32,7 +32,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -51,7 +51,7 @@ declare namespace $Types { $name: 'SomeModel' $description: undefined /** - * Nexus \`t.field\` related configuration based on the \`SomeModel.id\` field in your Prisma schema. + * Generated Nexus \`t.field\` configuration based on your Prisma schema's model-field \`SomeModel.id\`. * * Some documentation * @@ -116,12 +116,12 @@ declare namespace $Types { // /** - * Nexus \`objectType\` related configuration based on the \`SomeModel\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`SomeModel\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -131,7 +131,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -220,12 +220,12 @@ declare namespace $Types { // Models /** - * Nexus \`objectType\` related configuration based on the \`SomeModel\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`SomeModel\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -235,7 +235,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -254,12 +254,12 @@ declare namespace $Types { $name: 'SomeModel' $description: undefined /** - * Nexus \`t.field\` related configuration based on the \`SomeModel.id\` field in your Prisma schema. + * Generated Nexus \`t.field\` configuration based on your Prisma schema's model-field \`SomeModel.id\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * \`\`\`prisma * model SomeModel { @@ -268,7 +268,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -331,12 +331,12 @@ declare namespace $Types { // /** - * Nexus \`objectType\` related configuration based on the \`SomeModel\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`SomeModel\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -346,7 +346,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -435,7 +435,7 @@ declare namespace $Types { // Models /** - * Nexus \`objectType\` related configuration based on the \`SomeModel\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`SomeModel\`. * * Some documentation * @@ -456,12 +456,12 @@ declare namespace $Types { $name: 'SomeModel' $description: 'Some documentation' /** - * Nexus \`t.field\` related configuration based on the \`SomeModel.id\` field in your Prisma schema. + * Generated Nexus \`t.field\` configuration based on your Prisma schema's model-field \`SomeModel.id\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * \`\`\`prisma * model SomeModel { @@ -470,7 +470,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -533,7 +533,7 @@ declare namespace $Types { // /** - * Nexus \`objectType\` related configuration based on the \`SomeModel\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`SomeModel\`. * * Some documentation * @@ -624,12 +624,12 @@ declare namespace $Types { // Models /** - * Nexus \`objectType\` related configuration based on the \`SomeModel\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`SomeModel\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -639,7 +639,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -658,12 +658,12 @@ declare namespace $Types { $name: 'SomeModel' $description: undefined /** - * Nexus \`t.field\` related configuration based on the \`SomeModel.id\` field in your Prisma schema. + * Generated Nexus \`t.field\` configuration based on your Prisma schema's model-field \`SomeModel.id\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * \`\`\`prisma * model SomeModel { @@ -672,7 +672,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -735,12 +735,12 @@ declare namespace $Types { // /** - * Nexus \`objectType\` related configuration based on the \`SomeModel\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`SomeModel\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -750,7 +750,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * diff --git a/tests/unit/typescriptDeclarationFile/__snapshots__/modelRelationFields.test.ts.snap b/tests/unit/typescriptDeclarationFile/__snapshots__/modelRelationFields.test.ts.snap index 4d6d8b737..a6657d0e1 100644 --- a/tests/unit/typescriptDeclarationFile/__snapshots__/modelRelationFields.test.ts.snap +++ b/tests/unit/typescriptDeclarationFile/__snapshots__/modelRelationFields.test.ts.snap @@ -17,12 +17,12 @@ declare namespace $Types { // Models /** - * Nexus \`objectType\` related configuration based on the \`User\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`User\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model User * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model User + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -32,7 +32,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -51,12 +51,12 @@ declare namespace $Types { $name: 'User' $description: undefined /** - * Nexus \`t.field\` related configuration based on the \`User.id\` field in your Prisma schema. + * Generated Nexus \`t.field\` configuration based on your Prisma schema's model-field \`User.id\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model User * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model User + * by documenting it in your Prisma schema. For example: * * \`\`\`prisma * model User { @@ -65,7 +65,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -102,12 +102,12 @@ declare namespace $Types { resolve: NexusCore.FieldResolver<'User', 'id'> } /** - * Nexus \`t.field\` related configuration based on the \`User.posts\` field in your Prisma schema. + * Generated Nexus \`t.field\` configuration based on your Prisma schema's model-field \`User.posts\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model User * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model User + * by documenting it in your Prisma schema. For example: * * \`\`\`prisma * model User { @@ -116,7 +116,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -155,12 +155,12 @@ declare namespace $Types { } /** - * Nexus \`objectType\` related configuration based on the \`Post\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`Post\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model Post * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model Post + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -170,7 +170,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -189,12 +189,12 @@ declare namespace $Types { $name: 'Post' $description: undefined /** - * Nexus \`t.field\` related configuration based on the \`Post.id\` field in your Prisma schema. + * Generated Nexus \`t.field\` configuration based on your Prisma schema's model-field \`Post.id\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model Post * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model Post + * by documenting it in your Prisma schema. For example: * * \`\`\`prisma * model Post { @@ -203,7 +203,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -240,12 +240,12 @@ declare namespace $Types { resolve: NexusCore.FieldResolver<'Post', 'id'> } /** - * Nexus \`t.field\` related configuration based on the \`Post.author\` field in your Prisma schema. + * Generated Nexus \`t.field\` configuration based on your Prisma schema's model-field \`Post.author\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model Post * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model Post + * by documenting it in your Prisma schema. For example: * * \`\`\`prisma * model Post { @@ -254,7 +254,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -291,12 +291,12 @@ declare namespace $Types { resolve: NexusCore.FieldResolver<'Post', 'author'> } /** - * Nexus \`t.field\` related configuration based on the \`Post.authorId\` field in your Prisma schema. + * Generated Nexus \`t.field\` configuration based on your Prisma schema's model-field \`Post.authorId\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model Post * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model Post + * by documenting it in your Prisma schema. For example: * * \`\`\`prisma * model Post { @@ -305,7 +305,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -368,12 +368,12 @@ declare namespace $Types { // /** - * Nexus \`objectType\` related configuration based on the \`User\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`User\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model User * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model User + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -383,7 +383,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -401,12 +401,12 @@ declare namespace $Types { export const User: $Types.User /** - * Nexus \`objectType\` related configuration based on the \`Post\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`Post\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model Post * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model Post + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -416,7 +416,7 @@ export const User: $Types.User * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * diff --git a/tests/unit/typescriptDeclarationFile/__snapshots__/modelScalarFields.test.ts.snap b/tests/unit/typescriptDeclarationFile/__snapshots__/modelScalarFields.test.ts.snap index 6872b96fb..42be87f75 100644 --- a/tests/unit/typescriptDeclarationFile/__snapshots__/modelScalarFields.test.ts.snap +++ b/tests/unit/typescriptDeclarationFile/__snapshots__/modelScalarFields.test.ts.snap @@ -17,12 +17,12 @@ declare namespace $Types { // Models /** - * Nexus \`objectType\` related configuration based on the \`SomeModel\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`SomeModel\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -32,7 +32,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -51,12 +51,12 @@ declare namespace $Types { $name: 'SomeModel' $description: undefined /** - * Nexus \`t.field\` related configuration based on the \`SomeModel.id\` field in your Prisma schema. + * Generated Nexus \`t.field\` configuration based on your Prisma schema's model-field \`SomeModel.id\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * \`\`\`prisma * model SomeModel { @@ -65,7 +65,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -102,12 +102,12 @@ declare namespace $Types { resolve: NexusCore.FieldResolver<'SomeModel', 'id'> } /** - * Nexus \`t.field\` related configuration based on the \`SomeModel.foo\` field in your Prisma schema. + * Generated Nexus \`t.field\` configuration based on your Prisma schema's model-field \`SomeModel.foo\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * \`\`\`prisma * model SomeModel { @@ -116,7 +116,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -179,12 +179,12 @@ declare namespace $Types { // /** - * Nexus \`objectType\` related configuration based on the \`SomeModel\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`SomeModel\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -194,7 +194,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -283,12 +283,12 @@ declare namespace $Types { // Models /** - * Nexus \`objectType\` related configuration based on the \`SomeModel\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`SomeModel\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -298,7 +298,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -317,12 +317,12 @@ declare namespace $Types { $name: 'SomeModel' $description: undefined /** - * Nexus \`t.field\` related configuration based on the \`SomeModel.id\` field in your Prisma schema. + * Generated Nexus \`t.field\` configuration based on your Prisma schema's model-field \`SomeModel.id\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * \`\`\`prisma * model SomeModel { @@ -331,7 +331,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -368,12 +368,12 @@ declare namespace $Types { resolve: NexusCore.FieldResolver<'SomeModel', 'id'> } /** - * Nexus \`t.field\` related configuration based on the \`SomeModel.foo\` field in your Prisma schema. + * Generated Nexus \`t.field\` configuration based on your Prisma schema's model-field \`SomeModel.foo\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * \`\`\`prisma * model SomeModel { @@ -382,7 +382,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -445,12 +445,12 @@ declare namespace $Types { // /** - * Nexus \`objectType\` related configuration based on the \`SomeModel\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`SomeModel\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -460,7 +460,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -549,12 +549,12 @@ declare namespace $Types { // Models /** - * Nexus \`objectType\` related configuration based on the \`SomeModel\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`SomeModel\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -564,7 +564,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -583,12 +583,12 @@ declare namespace $Types { $name: 'SomeModel' $description: undefined /** - * Nexus \`t.field\` related configuration based on the \`SomeModel.id\` field in your Prisma schema. + * Generated Nexus \`t.field\` configuration based on your Prisma schema's model-field \`SomeModel.id\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * \`\`\`prisma * model SomeModel { @@ -597,7 +597,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -634,12 +634,12 @@ declare namespace $Types { resolve: NexusCore.FieldResolver<'SomeModel', 'id'> } /** - * Nexus \`t.field\` related configuration based on the \`SomeModel.foo\` field in your Prisma schema. + * Generated Nexus \`t.field\` configuration based on your Prisma schema's model-field \`SomeModel.foo\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * \`\`\`prisma * model SomeModel { @@ -648,7 +648,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -711,12 +711,12 @@ declare namespace $Types { // /** - * Nexus \`objectType\` related configuration based on the \`SomeModel\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`SomeModel\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -726,7 +726,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -815,12 +815,12 @@ declare namespace $Types { // Models /** - * Nexus \`objectType\` related configuration based on the \`SomeModel\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`SomeModel\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -830,7 +830,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -849,12 +849,12 @@ declare namespace $Types { $name: 'SomeModel' $description: undefined /** - * Nexus \`t.field\` related configuration based on the \`SomeModel.id\` field in your Prisma schema. + * Generated Nexus \`t.field\` configuration based on your Prisma schema's model-field \`SomeModel.id\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * \`\`\`prisma * model SomeModel { @@ -863,7 +863,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -900,12 +900,12 @@ declare namespace $Types { resolve: NexusCore.FieldResolver<'SomeModel', 'id'> } /** - * Nexus \`t.field\` related configuration based on the \`SomeModel.foo\` field in your Prisma schema. + * Generated Nexus \`t.field\` configuration based on your Prisma schema's model-field \`SomeModel.foo\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * \`\`\`prisma * model SomeModel { @@ -914,7 +914,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -977,12 +977,12 @@ declare namespace $Types { // /** - * Nexus \`objectType\` related configuration based on the \`SomeModel\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`SomeModel\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -992,7 +992,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -1081,12 +1081,12 @@ declare namespace $Types { // Models /** - * Nexus \`objectType\` related configuration based on the \`SomeModel\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`SomeModel\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -1096,7 +1096,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -1115,12 +1115,12 @@ declare namespace $Types { $name: 'SomeModel' $description: undefined /** - * Nexus \`t.field\` related configuration based on the \`SomeModel.id\` field in your Prisma schema. + * Generated Nexus \`t.field\` configuration based on your Prisma schema's model-field \`SomeModel.id\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * \`\`\`prisma * model SomeModel { @@ -1129,7 +1129,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -1166,12 +1166,12 @@ declare namespace $Types { resolve: NexusCore.FieldResolver<'SomeModel', 'id'> } /** - * Nexus \`t.field\` related configuration based on the \`SomeModel.foo\` field in your Prisma schema. + * Generated Nexus \`t.field\` configuration based on your Prisma schema's model-field \`SomeModel.foo\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * \`\`\`prisma * model SomeModel { @@ -1180,7 +1180,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -1243,12 +1243,12 @@ declare namespace $Types { // /** - * Nexus \`objectType\` related configuration based on the \`SomeModel\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`SomeModel\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -1258,7 +1258,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -1347,12 +1347,12 @@ declare namespace $Types { // Models /** - * Nexus \`objectType\` related configuration based on the \`SomeModel\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`SomeModel\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -1362,7 +1362,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -1381,12 +1381,12 @@ declare namespace $Types { $name: 'SomeModel' $description: undefined /** - * Nexus \`t.field\` related configuration based on the \`SomeModel.id\` field in your Prisma schema. + * Generated Nexus \`t.field\` configuration based on your Prisma schema's model-field \`SomeModel.id\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * \`\`\`prisma * model SomeModel { @@ -1395,7 +1395,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -1458,12 +1458,12 @@ declare namespace $Types { // /** - * Nexus \`objectType\` related configuration based on the \`SomeModel\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`SomeModel\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -1473,7 +1473,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -1562,12 +1562,12 @@ declare namespace $Types { // Models /** - * Nexus \`objectType\` related configuration based on the \`SomeModel\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`SomeModel\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -1577,7 +1577,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -1596,12 +1596,12 @@ declare namespace $Types { $name: 'SomeModel' $description: undefined /** - * Nexus \`t.field\` related configuration based on the \`SomeModel.id\` field in your Prisma schema. + * Generated Nexus \`t.field\` configuration based on your Prisma schema's model-field \`SomeModel.id\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * \`\`\`prisma * model SomeModel { @@ -1610,7 +1610,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -1647,12 +1647,12 @@ declare namespace $Types { resolve: NexusCore.FieldResolver<'SomeModel', 'id'> } /** - * Nexus \`t.field\` related configuration based on the \`SomeModel.foo\` field in your Prisma schema. + * Generated Nexus \`t.field\` configuration based on your Prisma schema's model-field \`SomeModel.foo\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * \`\`\`prisma * model SomeModel { @@ -1661,7 +1661,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -1724,12 +1724,12 @@ declare namespace $Types { // /** - * Nexus \`objectType\` related configuration based on the \`SomeModel\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`SomeModel\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -1739,7 +1739,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -1828,12 +1828,12 @@ declare namespace $Types { // Models /** - * Nexus \`objectType\` related configuration based on the \`SomeModel\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`SomeModel\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -1843,7 +1843,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -1862,12 +1862,12 @@ declare namespace $Types { $name: 'SomeModel' $description: undefined /** - * Nexus \`t.field\` related configuration based on the \`SomeModel.id\` field in your Prisma schema. + * Generated Nexus \`t.field\` configuration based on your Prisma schema's model-field \`SomeModel.id\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * \`\`\`prisma * model SomeModel { @@ -1876,7 +1876,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example * @@ -1939,12 +1939,12 @@ declare namespace $Types { // /** - * Nexus \`objectType\` related configuration based on the \`SomeModel\` model in your Prisma schema. + * Generated Nexus \`objectType\` configuration based on your Prisma schema's model \`SomeModel\`. * - * ### ️⚠️ Missing Documentation for this Model + * ### ️⚠️ You have not writen documentation for model SomeModel * - * Automatically ✨ enrich this JSDoc with information about your enum - * type by documenting it in your Prisma schema. For example: + * Replace this default advisory JSDoc with your own documentation about model SomeModel + * by documenting it in your Prisma schema. For example: * * * \`\`\`prisma @@ -1954,7 +1954,7 @@ declare namespace $Types { * } * \`\`\` * - * Learn more about Prisma Schema documentation comments [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). + * Learn more about documentation comments in Prisma schema files [here](https://www.prisma.io/docs/concepts/components/prisma-schema#comments). * * @example *