feat: listElementCount option (#88)

Add an option to configure how many list elements should be generated in mocks.

Author: Jimmy Paolini

README.md

@@ -28,6 +28,10 @@ specific type in a particular call stack, subsequent resolutions will return an
 The prefix to add to the mock function name. Cannot be empty since it will clash with the associated
 typescript definition from `@graphql-codegen/typescript`
 
+### listElementCount (`number`, defaultValue: `1`)
+
+How many elements should be generated for lists. For example, with `listElementCount: 3` a schema field `names: [String!]!` would generate `3` names in each mock.
+
 ### enumValues (`string`, defaultValue: `pascal-case#pascalCase`)
 
 Changes the case of the enums. Accepts `upper-case#upperCase`, `pascal-case#pascalCase` or `keep`

src/index.ts

@@ -1,4 +1,4 @@
-import { ASTKindToNode, NamedTypeNode, parse, printSchema, TypeNode } from 'graphql';
+import { ASTKindToNode, ListTypeNode, NamedTypeNode, parse, printSchema, TypeNode } from 'graphql';
 import casual from 'casual';
 import { PluginFunction, oldVisit } from '@graphql-codegen/plugin-helpers';
 import { pascalCase } from 'pascal-case';
@@ -21,6 +21,7 @@ type Options<T = TypeNode> = {
     currentType: T;
     customScalars?: ScalarMap;
     transformUnderscore: boolean;
+    listElementCount?: number;
     dynamicValues?: boolean;
 };
 
@@ -216,11 +217,14 @@ const generateMockValue = (opts: Options): string | number | boolean => {
                 currentType: opts.currentType.type,
             });
         case 'ListType': {
-            const value = generateMockValue({
-                ...opts,
-                currentType: opts.currentType.type,
-            });
-            return `[${value}]`;
+            const listElements = Array.from({ length: opts.listElementCount }, (_, index) =>
+                generateMockValue({
+                    ...opts,
+                    fieldName: opts.fieldName + index,
+                    currentType: (opts.currentType as ListTypeNode).type,
+                }),
+            );
+            return `[${listElements.join(', ')}]`;
         }
         default:
             throw new Error('unreached');
@@ -326,6 +330,7 @@ export interface TypescriptMocksPluginConfig {
     typesPrefix?: string;
     enumsPrefix?: string;
     transformUnderscore?: boolean;
+    listElementCount?: number;
     dynamicValues?: boolean;
 }
 
@@ -365,6 +370,7 @@ export const plugin: PluginFunction<TypescriptMocksPluginConfig> = (schema, docu
     const enumValuesConvention = config.enumValues || 'pascal-case#pascalCase';
     const typenamesConvention = config.typenames || 'pascal-case#pascalCase';
     const transformUnderscore = config.transformUnderscore ?? true;
+    const listElementCount = config.listElementCount > 0 ? config.listElementCount : 1;
     // List of types that are enums
     const types: TypeItem[] = [];
     const visitor: VisitorType = {
@@ -407,6 +413,7 @@ export const plugin: PluginFunction<TypescriptMocksPluginConfig> = (schema, docu
                         currentType: node.type,
                         customScalars: config.scalars,
                         transformUnderscore,
+                        listElementCount,
                         dynamicValues: config.dynamicValues,
                     });