Add inputMaybeValueDefault option to allow default input values other than null (#63)

* Add inputMaybeValueDefault option to allow default input values other than null

* Add requirements for contributing

* Add highlight on example code

* Fix formatting issues

* Update snapshots

Co-authored-by: Dimitri van der Vliet <[email protected]>
Co-authored-by: Gabin Aureche <[email protected]>

Author: 3 people

changelog.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- Add inputMaybeValueDefault option to allow default input values other than null
+
 ## 1.0.0 - 2022-05-07
 
 ### Added

docs/docs/configuration/schema.mdx

@@ -316,3 +316,49 @@ export function createUserMock(
 </div>
 
 </details>
+
+## `config.inputMaybeValueDefault`
+
+By default, this plugin will always generate a null value for input types that are nullable.
+This can be problematic when you customized the inputMaybeValue.
+You can customize the default value by configuring `inputMaybeValueDefault`:
+
+```yml
+overwrite: true
+schema: ./schema.graphql
+generates:
+  ./types.ts:
+    plugins:
+      - typescript
+      - graphql-codegen-factories/schema
+    config:
+      inputMaybeValue: T | undefined
+      # highlight-start
+      inputMaybeValueDefault: undefined
+      # highlight-end
+```
+
+<details>
+<summary>Example</summary>
+
+<div className="codeBlocks">
+
+```graphql title="schema.graphql"
+input PostInput {
+  title: String
+}
+```
+
+```typescript title="types.ts"
+export function createPostInputMock(props: Partial<PostInput> = {}): PostInput {
+  return {
+    // highlight-start
+    title: undefined,
+    // highlight-end
+    ...props,
+  };
+}
+```
+
+</div>
+</details>

packages/graphql-codegen-factories/src/schema/FactoriesSchemaVisitor.ts

@@ -50,6 +50,8 @@ export interface FactoriesSchemaVisitorRawConfig
   // the following option does the same thing as namespacedImportName
   // but it is injected automatically while this one is provided by the user
   importTypesNamespace?: string;
+
+  inputMaybeValueDefault?: string;
 }
 
 export interface FactoriesSchemaVisitorParsedConfig
@@ -59,6 +61,7 @@ export interface FactoriesSchemaVisitorParsedConfig
   namespacedImportName: string | null;
   typesPath?: string;
   importTypesNamespace?: string;
+  inputMaybeValueDefault: string | "null";
 }
 
 interface VisitedTypeNode {
@@ -117,6 +120,10 @@ export class FactoriesSchemaVisitor extends FactoriesBaseVisitor<
         config.importTypesNamespace,
         undefined
       ),
+      inputMaybeValueDefault: getConfigValue(
+        config.inputMaybeValueDefault,
+        "null"
+      ),
     } as FactoriesSchemaVisitorParsedConfig;
 
     if (parsedConfig.typesPath && parsedConfig.namespacedImportName == null) {
@@ -209,11 +216,16 @@ export class FactoriesSchemaVisitor extends FactoriesBaseVisitor<
   }
 
   protected convertField(
-    node: UnvisitedFieldDefinitionNode | UnvisitedInputValueDefinitionNode
+    node: UnvisitedFieldDefinitionNode | UnvisitedInputValueDefinitionNode,
+    nullableDefaultValue: string
   ): string {
     const { defaultValue, isNullable } = node.type;
     return indent(
-      indent(`${node.name.value}: ${isNullable ? "null" : defaultValue},`)
+      indent(
+        `${node.name.value}: ${
+          isNullable ? nullableDefaultValue : defaultValue
+        },`
+      )
     );
   }
 
@@ -283,15 +295,15 @@ export class FactoriesSchemaVisitor extends FactoriesBaseVisitor<
   }
 
   FieldDefinition(node: UnvisitedFieldDefinitionNode): string {
-    return this.convertField(node);
+    return this.convertField(node, "null");
   }
 
   InputObjectTypeDefinition(node: InputObjectTypeDefinitionNode): string {
     return this.convertObjectType(node);
   }
 
   InputValueDefinition(node: UnvisitedInputValueDefinitionNode): string {
-    return this.convertField(node);
+    return this.convertField(node, this.config.inputMaybeValueDefault);
   }
 
   ObjectTypeDefinition(node: ObjectTypeDefinitionNode): string | undefined {

packages/graphql-codegen-factories/src/schema/__tests__/__snapshots__/plugin.ts.snap

@@ -136,6 +136,19 @@ Object {
 }
 `;
 
+exports[`plugin should customize the input maybe value default 1`] = `
+Object {
+  "content": "export function createPostInputMock(props: Partial<PostInput> = {}): PostInput {
+  return {
+    title: undefined,
+    ...props,
+  };
+}
+",
+  "prepend": Array [],
+}
+`;
+
 exports[`plugin should import types from other file 1`] = `
 Object {
   "content": "export function createUserMock(props: Partial<SharedTypes.User> = {}): SharedTypes.User {

packages/graphql-codegen-factories/src/schema/__tests__/plugin.ts

@@ -117,6 +117,19 @@ describe("plugin", () => {
     expect(output).toMatchSnapshot();
   });
 
+  it("should customize the input maybe value default", async () => {
+    const schema = buildSchema(`
+      input PostInput {
+        title: String
+      }
+    `);
+
+    const output = await plugin(schema, [], {
+      inputMaybeValueDefault: "undefined",
+    });
+    expect(output).toMatchSnapshot();
+  });
+
   it("should support enums with an underscore", async () => {
     const schema = buildSchema(`
       enum UserRole {

readme.md

@@ -92,4 +92,6 @@ Are you using this plugin? [Let us know!](https://github.com/zhouzi/graphql-code
 
 ## Contributors
 
-[![](https://github.com/zhouzi.png?size=50)](https://github.com/zhouzi) [![](https://github.com/ertrzyiks.png?size=50)](https://github.com/ertrzyiks)
+[![](https://github.com/zhouzi.png?size=50)](https://github.com/zhouzi)
+[![](https://github.com/ertrzyiks.png?size=50)](https://github.com/ertrzyiks)
+[![](https://github.com/jongbelegen.png?size=50)](https://github.com/jongbelegen)