feat: update and use faker as default generator

README.md

@@ -207,60 +207,16 @@ In the above example all resolvers with the name `email` will use the `internet.
 
 For detailed configuration options, see [GeneratorOptions](#generatoroptions-type) documentation.
 
-### generateLibrary (`'casual' | 'faker'`, defaultValue: `'casual'`)
+### generateLibrary (`'casual' | 'faker'`, defaultValue: `'faker'`)
 
-Select a library to generate mock values. The default is [casual](https://github.com/boo1ean/casual), Other options include [faker](https://github.com/faker-js/faker).
-casual dependents on Node API and cannot be executed in a browser. faker is useful when you want to use a mock function with the dynamicValues option enabled in the browser.
+Select a library to generate mock values. The default is [faker](https://github.com/faker-js/faker), Other options include [casual](https://github.com/boo1ean/casual)
+casual is not maintained and will be remove in future major versions.
+faker is useful when you want to use a mock function with the dynamicValues option enabled in the browser.
 
 ### `GeneratorOptions` type
 
 This type is used in `scalars` and `fieldGeneration` options.
 
-Examples using **casual**
-
-**Shorthand if you don't have arguments**
-
-```yaml
-fieldName: date # gets translated to casual.date()
-```
-
-**With arguments**
-
-```yaml
-fieldName: # gets translated to casual.date('YYYY-MM-DD')
-  generator: date
-  arguments: 'YYYY-MM-DD'
-```
-
-**With multiple arguments**
-
-```yaml
-fieldName: # gets translated to casual.integer(-100, 100)
-  generator: integer
-  arguments:
-    - -100
-    - 100
-```
-
-**With extra function call**
-
-```yaml
-fieldName: # gets translated to casual.integer.toFixed()
-  generator: integer
-  extra:
-    function: toFixed
-```
-
-**With extra function call arguments**
-
-```yaml
-fieldName: # gets translated to casual.integer.toFixed(3)
-  generator: integer
-  extra:
-    function: toFixed
-    arguments: 3
-```
-
 Examples using **faker**
 
 **With arguments**
@@ -299,17 +255,17 @@ plugins:
 **With extra function call**
 
 ```yaml
-fieldName: # gets translated to casual.date().toLocaleDateString()
-  generator: date
+fieldName: # gets translated to faker.date.past().toLocaleDateString()
+  generator: date.past
   extra:
     function: toLocaleDateString
 ```
 
 **With extra function call arguments**
 
 ```yaml
-fieldName: # gets translated to casual.date().toLocaleDateString('en_GB)
-  generator: date
+fieldName: # gets translated to faker.date.past().toLocaleDateString('en_GB)
+  generator: date.past
   extra:
     function: toLocaleDateString
     arguments: 'en_GB'
@@ -322,6 +278,51 @@ fieldName: # gets translated to casual.date().toLocaleDateString('en_GB)
 fieldName: arrayBufferGenerator()
 ```
 
+Examples using **casual** (deprecated)
+
+**Shorthand if you don't have arguments**
+
+```yaml
+fieldName: date # gets translated to casual.date()
+```
+
+**With arguments**
+
+```yaml
+fieldName: # gets translated to casual.date('YYYY-MM-DD')
+  generator: date
+  arguments: 'YYYY-MM-DD'
+```
+
+**With multiple arguments**
+
+```yaml
+fieldName: # gets translated to casual.integer(-100, 100)
+  generator: integer
+  arguments:
+    - -100
+    - 100
+```
+
+**With extra function call**
+
+```yaml
+fieldName: # gets translated to casual.integer.toFixed()
+  generator: integer
+  extra:
+    function: toFixed
+```
+
+**With extra function call arguments**
+
+```yaml
+fieldName: # gets translated to casual.integer.toFixed(3)
+  generator: integer
+  extra:
+    function: toFixed
+    arguments: 3
+```
+
 ## Examples of usage
 
 **codegen.yml**
@@ -340,7 +341,7 @@ generates:
           enumValues: upper-case#upperCase
           typeNames: keep
           scalars:
-            AWSTimestamp: unix_time # gets translated to casual.unix_time
+            AWSTimestamp: number.int # gets translated to faker.number.int()
 ```
 
 ### With `eslint-disable` rule
@@ -363,7 +364,7 @@ generates:
           enumValues: upper-case#upperCase
           typeNames: keep
           scalars:
-            AWSTimestamp: unix_time # gets translated to casual.unix_time
+            AWSTimestamp: number.int # gets translated to faker.number.int()
 ```
 
 ## Example of generated code

package.json

@@ -22,7 +22,7 @@
         "fakes"
     ],
     "dependencies": {
-        "@faker-js/faker": "^7.5.0",
+        "@faker-js/faker": "^8.4.1",
         "@graphql-codegen/plugin-helpers": "^5.0.4",
         "casual": "^1.6.2",
         "change-case-all": "^1.0.15",

src/index.ts

@@ -7,7 +7,7 @@ import {
     NamedTypeNode,
     ObjectTypeDefinitionNode,
 } from 'graphql';
-import { faker } from '@faker-js/faker';
+import * as allFakerLocales from '@faker-js/faker';
 import casual from 'casual';
 import { oldVisit, PluginFunction, resolveExternalModuleAndFn } from '@graphql-codegen/plugin-helpers';
 import { sentenceCase } from 'sentence-case';
@@ -32,6 +32,7 @@ type Options<T = TypeNode> = {
     listElementCount: number;
     dynamicValues: boolean;
     generateLibrary: 'casual' | 'faker';
+    generatorLocale: string;
     fieldGeneration?: TypeFieldMap;
     enumsAsTypes?: boolean;
     useTypeImports?: boolean;
@@ -146,8 +147,8 @@ const getCasualCustomValue = (
     return value;
 };
 
-const getFakerGenerators = (generatorName: GeneratorName) => {
-    let embeddedGenerator: unknown = faker;
+const getFakerGenerators = (generatorName: GeneratorName, locale: string) => {
+    let embeddedGenerator: unknown = allFakerLocales[`faker${locale.toUpperCase()}`];
     let dynamicGenerator = 'faker';
 
     if (typeof generatorName === 'string') {
@@ -173,7 +174,10 @@ const getFakerCustomValue = (
     opts: Options<NamedTypeNode | ObjectTypeDefinitionNode>,
 ) => {
     // If there is a mapping to a `faker` type, then use it
-    const { embeddedGenerator, dynamicGenerator } = getFakerGenerators(generatorDefinition.generator);
+    const { embeddedGenerator, dynamicGenerator } = getFakerGenerators(
+        generatorDefinition.generator,
+        opts.generatorLocale,
+    );
     if (!embeddedGenerator && generatorDefinition.generator) {
         return generatorDefinition.generator;
     }
@@ -278,6 +282,7 @@ const getNamedType = (opts: Options<NamedTypeNode | ObjectTypeDefinitionNode>):
     const mockValueGenerator = setupMockValueGenerator({
         generateLibrary: opts.generateLibrary,
         dynamicValues: opts.dynamicValues,
+        generatorLocale: opts.generatorLocale,
     });
     if (!opts.dynamicValues) mockValueGenerator.seed(hashedString(opts.typeName + opts.fieldName));
     const name = opts.currentType.name.value;
@@ -603,15 +608,12 @@ export const plugin: PluginFunction<TypescriptMocksPluginConfig> = (schema, docu
     const transformUnderscore = config.transformUnderscore ?? true;
     const listElementCount = Math.max(0, config.listElementCount ?? 1);
     const dynamicValues = !!config.dynamicValues;
-    const generateLibrary = config.generateLibrary || 'casual';
+    const generateLibrary = config.generateLibrary || 'faker';
     const enumsAsTypes = config.enumsAsTypes ?? false;
     const useTypeImports = config.useTypeImports ?? false;
     const useImplementingTypes = config.useImplementingTypes ?? false;
     const defaultNullableToNull = config.defaultNullableToNull ?? false;
-
-    if (generateLibrary === 'faker' && config.locale) {
-        faker.setLocale(config.locale);
-    }
+    const generatorLocale = config.locale || 'en';
 
     // List of types that are enums
     const types: TypeItem[] = [];
@@ -684,6 +686,7 @@ export const plugin: PluginFunction<TypescriptMocksPluginConfig> = (schema, docu
                         listElementCount,
                         dynamicValues,
                         generateLibrary,
+                        generatorLocale,
                         fieldGeneration: config.fieldGeneration,
                         enumsAsTypes,
                         useTypeImports,
@@ -721,6 +724,7 @@ export const plugin: PluginFunction<TypescriptMocksPluginConfig> = (schema, docu
                                       listElementCount,
                                       dynamicValues,
                                       generateLibrary,
+                                      generatorLocale,
                                       fieldGeneration: config.fieldGeneration,
                                       enumsAsTypes,
                                       useTypeImports,
@@ -817,7 +821,7 @@ export const plugin: PluginFunction<TypescriptMocksPluginConfig> = (schema, docu
         .filter((mockFn: () => string) => !!mockFn)
         .map((mockFn: () => string) => mockFn())
         .join('\n');
-    const functionTokens = setupFunctionTokens(generateLibrary);
+    const functionTokens = setupFunctionTokens(generateLibrary, generatorLocale);
 
     let mockFile = '';
     if (dynamicValues) mockFile += `${functionTokens.import}\n`;

src/mockValueGenerator.ts

@@ -1,4 +1,5 @@
-import { faker } from '@faker-js/faker';
+import { Faker } from '@faker-js/faker';
+import * as allFakerLocales from '@faker-js/faker';
 import casual from 'casual';
 
 interface MockValueGenerator {
@@ -14,12 +15,14 @@ interface MockValueGenerator {
 
 type MockValueGeneratorOptions = {
     dynamicValues: boolean;
+    generatorLocale: string;
 };
 
 type FunctionTokens = Record<'import' | 'seed' | 'seedFunction', string>;
 
 type SetupMockValueGeneratorOptions = {
     generateLibrary: 'casual' | 'faker';
+    generatorLocale: string;
     dynamicValues: boolean;
 };
 
@@ -53,52 +56,61 @@ const casualFunctionTokens: FunctionTokens = {
 
 class FakerMockValueGenerator implements MockValueGenerator {
     dynamicValues: boolean;
+    private fakerInstance: Faker;
 
     constructor(opts: MockValueGeneratorOptions) {
         this.dynamicValues = opts.dynamicValues;
+        const fakerImport = `faker${opts.generatorLocale.toUpperCase()}`;
+        if (!(fakerImport in allFakerLocales)) {
+            throw new Error(`Cannot find faker version for locale ${opts.generatorLocale.toUpperCase()}`);
+        }
+        this.fakerInstance = allFakerLocales[`faker${opts.generatorLocale.toUpperCase()}`];
     }
 
-    word = () => (this.dynamicValues ? `faker.lorem.word()` : `'${faker.lorem.word()}'`);
-    uuid = () => (this.dynamicValues ? `faker.datatype.uuid()` : `'${faker.datatype.uuid()}'`);
-    boolean = () => (this.dynamicValues ? `faker.datatype.boolean()` : faker.datatype.boolean());
+    word = () => (this.dynamicValues ? `faker.lorem.word()` : `'${this.fakerInstance.lorem.word()}'`);
+    uuid = () => (this.dynamicValues ? `faker.string.uuid()` : `'${this.fakerInstance.string.uuid()}'`);
+    boolean = () => (this.dynamicValues ? `faker.datatype.boolean()` : this.fakerInstance.datatype.boolean());
     integer = () =>
         this.dynamicValues
-            ? `faker.datatype.number({ min: 0, max: 9999 })`
-            : faker.datatype.number({ min: 0, max: 9999 });
+            ? `faker.number.int({ min: 0, max: 9999 })`
+            : this.fakerInstance.number.int({ min: 0, max: 9999 });
     float = () =>
         this.dynamicValues
-            ? `faker.datatype.float({ min: 0, max: 10, precision: 0.1 })`
-            : faker.datatype.float({ min: 0, max: 10, precision: 0.1 });
+            ? `faker.number.float({ min: 0, max: 10, fractionDigits: 1 })`
+            : this.fakerInstance.number.float({ min: 0, max: 10, fractionDigits: 1 });
     date = () =>
         this.dynamicValues
-            ? `faker.date.past(1, new Date(2022, 0)).toISOString()`
-            : `'${faker.date.past(1, new Date(2022, 0)).toISOString()}'`;
-    seed = (seed: number) => faker.seed(seed);
+            ? `faker.date.past({ years: 1, refDate: new Date(2022, 0) }).toISOString()`
+            : `'${this.fakerInstance.date.past({ years: 1, refDate: new Date(2022, 0) }).toISOString()}'`;
+    seed = (seed: number) => this.fakerInstance.seed(seed);
 }
 
-const fakerFunctionTokens: FunctionTokens = {
-    import: `import { faker } from '@faker-js/faker';`,
-    seed: 'faker.seed(0);',
-    seedFunction: 'export const seedMocks = (seed: number) => faker.seed(seed);',
-};
+function getFakerFunctionTokens(locale = 'en'): FunctionTokens {
+    return {
+        import: `import { faker${locale.toUpperCase()} as faker } from '@faker-js/faker';`,
+        seed: 'faker.seed(0);',
+        seedFunction: 'export const seedMocks = (seed: number) => faker.seed(seed);',
+    };
+}
 
 export const setupMockValueGenerator = ({
     generateLibrary,
     dynamicValues,
+    generatorLocale,
 }: SetupMockValueGeneratorOptions): MockValueGenerator => {
     switch (generateLibrary) {
         case 'casual':
-            return new CasualMockValueGenerator({ dynamicValues });
+            return new CasualMockValueGenerator({ dynamicValues, generatorLocale });
         case 'faker':
-            return new FakerMockValueGenerator({ dynamicValues });
+            return new FakerMockValueGenerator({ dynamicValues, generatorLocale });
     }
 };
 
-export const setupFunctionTokens = (generateLibrary: 'casual' | 'faker'): FunctionTokens => {
+export const setupFunctionTokens = (generateLibrary: 'casual' | 'faker', locale?: string): FunctionTokens => {
     switch (generateLibrary) {
         case 'casual':
             return casualFunctionTokens;
         case 'faker':
-            return fakerFunctionTokens;
+            return getFakerFunctionTokens(locale);
     }
 };