Add maybeValueDefault configuration option (#67)

* Add maybeValueDefault

* Default inputMaybeValueDefault to maybeValueDefault

* Update documentation

Author: zhouzi

changelog.md

@@ -2,7 +2,8 @@
 
 ## Unreleased
 
-- Add inputMaybeValueDefault option to allow default input values other than null
+- Add `maybeValueDefault` option to customize the nullable fields' default value
+- Add `inputMaybeValueDefault` option to customize the nullable inputs' fields' default value
 
 ## 1.0.0 - 2022-05-07
 

docs/docs/configuration/schema.mdx

@@ -317,11 +317,69 @@ export function createUserMock(
 
 </details>
 
+## `config.maybeValueDefault`
+
+By default, nullable fields are initialized as "null".
+
+You can customize this default value through `maybeValueDefault`:
+
+```yml
+overwrite: true
+schema: ./schema.graphql
+generates:
+  ./types.ts:
+    plugins:
+      - typescript
+      - graphql-codegen-factories/schema
+    config:
+      # highlight-start
+      maybeValueDefault: undefined
+      # highlight-end
+```
+
+<details>
+<summary>Example</summary>
+
+<div className="codeBlocks">
+
+```graphql title="schema.graphql"
+type Post {
+  title: String
+}
+
+input PostInput {
+  title: String
+}
+```
+
+```typescript title="types.ts"
+export function createPost(props: Partial<Post> = {}): Post {
+  return {
+    // highlight-start
+    title: undefined,
+    // highlight-end
+    ...props,
+  };
+}
+
+export function createPostInputMock(props: Partial<PostInput> = {}): PostInput {
+  return {
+    // highlight-start
+    title: undefined,
+    // highlight-end
+    ...props,
+  };
+}
+```
+
+</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`:
+By default, inputs' nullable fields are initialized as `config.maybeValueDefault` ("null" by default).
+
+You can customize this default value through `inputMaybeValueDefault`:
 
 ```yml
 overwrite: true
@@ -332,7 +390,6 @@ generates:
       - typescript
       - graphql-codegen-factories/schema
     config:
-      inputMaybeValue: T | undefined
       # highlight-start
       inputMaybeValueDefault: undefined
       # highlight-end

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

@@ -51,6 +51,7 @@ export interface FactoriesSchemaVisitorRawConfig
   // but it is injected automatically while this one is provided by the user
   importTypesNamespace?: string;
 
+  maybeValueDefault?: string;
   inputMaybeValueDefault?: string;
 }
 
@@ -61,7 +62,8 @@ export interface FactoriesSchemaVisitorParsedConfig
   namespacedImportName: string | null;
   typesPath?: string;
   importTypesNamespace?: string;
-  inputMaybeValueDefault: string | "null";
+  maybeValueDefault: string;
+  inputMaybeValueDefault: string;
 }
 
 interface VisitedTypeNode {
@@ -108,6 +110,11 @@ export class FactoriesSchemaVisitor extends FactoriesBaseVisitor<
   >;
 
   constructor(schema: GraphQLSchema, config: FactoriesSchemaVisitorRawConfig) {
+    const maybeValueDefault = getConfigValue(config.maybeValueDefault, "null");
+    const inputMaybeValueDefault = getConfigValue(
+      config.inputMaybeValueDefault,
+      maybeValueDefault
+    );
     const parsedConfig = {
       enumsAsTypes: getConfigValue(config.enumsAsTypes, false),
       scalarDefaults: getConfigValue(config.scalarDefaults, {}),
@@ -120,10 +127,8 @@ export class FactoriesSchemaVisitor extends FactoriesBaseVisitor<
         config.importTypesNamespace,
         undefined
       ),
-      inputMaybeValueDefault: getConfigValue(
-        config.inputMaybeValueDefault,
-        "null"
-      ),
+      maybeValueDefault,
+      inputMaybeValueDefault,
     } as FactoriesSchemaVisitorParsedConfig;
 
     if (parsedConfig.typesPath && parsedConfig.namespacedImportName == null) {
@@ -295,7 +300,7 @@ export class FactoriesSchemaVisitor extends FactoriesBaseVisitor<
   }
 
   FieldDefinition(node: UnvisitedFieldDefinitionNode): string {
-    return this.convertField(node, "null");
+    return this.convertField(node, this.config.maybeValueDefault);
   }
 
   InputObjectTypeDefinition(node: InputObjectTypeDefinitionNode): string {

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

@@ -149,6 +149,48 @@ Object {
 }
 `;
 
+exports[`plugin should customize the maybe value default 1`] = `
+Object {
+  "content": "export function createPostMock(props: Partial<Post> = {}): Post {
+  return {
+    __typename: \\"Post\\",
+    title: undefined,
+    ...props,
+  };
+}
+
+export function createPostInputMock(props: Partial<PostInput> = {}): PostInput {
+  return {
+    title: undefined,
+    ...props,
+  };
+}
+",
+  "prepend": Array [],
+}
+`;
+
+exports[`plugin should customize the maybe value default and input maybe value default independently 1`] = `
+Object {
+  "content": "export function createPostMock(props: Partial<Post> = {}): Post {
+  return {
+    __typename: \\"Post\\",
+    title: undefined,
+    ...props,
+  };
+}
+
+export function createPostInputMock(props: Partial<PostInput> = {}): PostInput {
+  return {
+    title: null,
+    ...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,39 @@ describe("plugin", () => {
     expect(output).toMatchSnapshot();
   });
 
+  it("should customize the maybe value default", async () => {
+    const schema = buildSchema(`
+      type Post {
+        title: String
+      }
+      input PostInput {
+        title: String
+      }
+    `);
+
+    const output = await plugin(schema, [], {
+      maybeValueDefault: "undefined",
+    });
+    expect(output).toMatchSnapshot();
+  });
+
+  it("should customize the maybe value default and input maybe value default independently", async () => {
+    const schema = buildSchema(`
+      type Post {
+        title: String
+      }
+      input PostInput {
+        title: String
+      }
+    `);
+
+    const output = await plugin(schema, [], {
+      maybeValueDefault: "undefined",
+      inputMaybeValueDefault: "null",
+    });
+    expect(output).toMatchSnapshot();
+  });
+
   it("should customize the input maybe value default", async () => {
     const schema = buildSchema(`
       input PostInput {