fix: description type should not be null (#24)

graphql-nexus · Apr 23, 2021 · cffc94d · cffc94d
1 parent 2f0023f
commit cffc94d
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 17 deletions.
diff --git a/src/generator/models/declaration.ts b/src/generator/models/declaration.ts
@@ -121,7 +121,7 @@ function renderTypeScriptDeclarationForEnum(enum_: DMMF.DatamodelEnum): string {
     ${jsDocForEnum(enum_)}
     interface ${enum_.name} {
       name: '${enum_.name}'
-      description: ${enum_.documentation ? `'${enum_.documentation}'` : 'null'}
+      description: ${enum_.documentation ? `'${enum_.documentation}'` : 'undefined'}
       members: [${enum_.values.map((value) => `'${value.name}'`).join(', ')}]
     }
   `
@@ -132,7 +132,7 @@ function renderTypeScriptDeclarationForModel(model: DMMF.Model): string {
     ${jsDocForModel(model)}
     interface ${model.name} {
       $name: '${model.name}'
-      $description: ${model.documentation ? `'${model.documentation}'` : 'null'}
+      $description: ${model.documentation ? `'${model.documentation}'` : 'undefined'}
       ${renderTypeScriptDeclarationForModelFields(model)}
     }
   `

diff --git a/src/generator/models/javascript.ts b/src/generator/models/javascript.ts
@@ -57,7 +57,7 @@ type NexusObjectTypeDefConfiguration = Record<
     }
   // Metadata fields can be any of these
   | string
-  | null
+  | undefined
 >
 
 /**
@@ -68,13 +68,13 @@ function createNexusObjectTypeDefConfigurations(dmmf: DMMF.Document): NexusObjec
     .map((model) => {
       return {
         $name: model.name,
-        $description: model.documentation ?? null,
+        $description: model.documentation ?? undefined,
         ...chain(model.fields)
           .map((field) => {
             return {
               name: field.name,
               type: prismaFieldToNexusType(field),
-              description: field.documentation ?? null,
+              description: field.documentation ?? undefined,
             }
           })
           .keyBy('name')

diff --git a/tests/unit/typescriptDeclarationFile/__snapshots__/enum.test.ts.snap b/tests/unit/typescriptDeclarationFile/__snapshots__/enum.test.ts.snap
@@ -47,7 +47,7 @@ declare namespace $Types {
     */
   interface Foo {
     name: 'Foo'
-    description: null
+    description: undefined
     members: ['a']
   }
 }

diff --git a/tests/unit/typescriptDeclarationFile/__snapshots__/enumDoc.test.ts.snap b/tests/unit/typescriptDeclarationFile/__snapshots__/enumDoc.test.ts.snap
@@ -131,7 +131,7 @@ declare namespace $Types {
     */
   interface Foo {
     name: 'Foo'
-    description: null
+    description: undefined
     members: ['a']
   }
 }

diff --git a/tests/unit/typescriptDeclarationFile/__snapshots__/modelDocumentation.test.ts.snap b/tests/unit/typescriptDeclarationFile/__snapshots__/modelDocumentation.test.ts.snap
@@ -49,7 +49,7 @@ declare namespace $Types {
     */
   interface SomeModel {
     $name: 'SomeModel'
-    $description: null
+    $description: undefined
     /**
      * Nexus \`t.field\` related configuration based on the \`SomeModel.id\` field in your Prisma schema.
       *
@@ -204,7 +204,7 @@ declare namespace $Types {
     */
   interface SomeModel {
     $name: 'SomeModel'
-    $description: null
+    $description: undefined
     /**
      * Nexus \`t.field\` related configuration based on the \`SomeModel.id\` field in your Prisma schema.
       *
@@ -512,7 +512,7 @@ declare namespace $Types {
     */
   interface SomeModel {
     $name: 'SomeModel'
-    $description: null
+    $description: undefined
     /**
      * Nexus \`t.field\` related configuration based on the \`SomeModel.id\` field in your Prisma schema.
       *

diff --git a/tests/unit/typescriptDeclarationFile/__snapshots__/modelScalarFields.test.ts.snap b/tests/unit/typescriptDeclarationFile/__snapshots__/modelScalarFields.test.ts.snap
@@ -49,7 +49,7 @@ declare namespace $Types {
     */
   interface SomeModel {
     $name: 'SomeModel'
-    $description: null
+    $description: undefined
     /**
      * Nexus \`t.field\` related configuration based on the \`SomeModel.id\` field in your Prisma schema.
       *
@@ -262,7 +262,7 @@ declare namespace $Types {
     */
   interface SomeModel {
     $name: 'SomeModel'
-    $description: null
+    $description: undefined
     /**
      * Nexus \`t.field\` related configuration based on the \`SomeModel.id\` field in your Prisma schema.
       *
@@ -475,7 +475,7 @@ declare namespace $Types {
     */
   interface SomeModel {
     $name: 'SomeModel'
-    $description: null
+    $description: undefined
     /**
      * Nexus \`t.field\` related configuration based on the \`SomeModel.id\` field in your Prisma schema.
       *
@@ -688,7 +688,7 @@ declare namespace $Types {
     */
   interface SomeModel {
     $name: 'SomeModel'
-    $description: null
+    $description: undefined
     /**
      * Nexus \`t.field\` related configuration based on the \`SomeModel.id\` field in your Prisma schema.
       *
@@ -901,7 +901,7 @@ declare namespace $Types {
     */
   interface SomeModel {
     $name: 'SomeModel'
-    $description: null
+    $description: undefined
     /**
      * Nexus \`t.field\` related configuration based on the \`SomeModel.id\` field in your Prisma schema.
       *
@@ -1068,7 +1068,7 @@ declare namespace $Types {
     */
   interface SomeModel {
     $name: 'SomeModel'
-    $description: null
+    $description: undefined
     /**
      * Nexus \`t.field\` related configuration based on the \`SomeModel.id\` field in your Prisma schema.
       *
@@ -1281,7 +1281,7 @@ declare namespace $Types {
     */
   interface SomeModel {
     $name: 'SomeModel'
-    $description: null
+    $description: undefined
     /**
      * Nexus \`t.field\` related configuration based on the \`SomeModel.id\` field in your Prisma schema.
       *