feat(name): add full_name_pattern configuration #1211

src/locales/ja/name/full_name_pattern.ts

@@ -0,0 +1,5 @@
+export default [
+  '{{last_name}} {{first_name}}',
+  '{{last_name}} {{male_first_name}}',
+  '{{last_name}} {{female_first_name}}',
+];

src/locales/ja/name/index.ts

@@ -5,13 +5,15 @@
 import type { NameDefinitions } from '../../..';
 import female_first_name from './female_first_name';
 import first_name from './first_name';
+import full_name_pattern from './full_name_pattern';
 import last_name from './last_name';
 import male_first_name from './male_first_name';
 import name_ from './name';
 
 const name: NameDefinitions = {
   female_first_name,
   first_name,
+  full_name_pattern,
   last_name,
   male_first_name,
   name: name_,

src/locales/ja/name/name.ts

@@ -1 +1,5 @@
-export default ['{{name.last_name}} {{name.first_name}}'];
+export default [
+  '{{name.last_name}} {{name.first_name}}',
+  '{{name.last_name}} {{name.male_first_name}}',
+  '{{name.last_name}} {{name.female_first_name}}',
+];

src/modules/name/index.ts

@@ -12,17 +12,13 @@ export enum Gender {
   male = 'male',
 }
 
-/**
- * @deprecated Use SexType instead.
- */
-export type GenderType = SexType;
-
 export enum Sex {
   Female = 'female',
   Male = 'male',
 }
 
 export type SexType = `${Sex}`;
+export type GenderType = 'female' | 'male';
 
 /**
  * Select a definition based on given sex.
@@ -229,7 +225,6 @@ export class Name {
     if (prefix) {
       nameParts.push(prefix);
     }
-
     nameParts.push(firstName);
     nameParts.push(lastName);
 
@@ -240,8 +235,45 @@ export class Name {
     if (suffix) {
       nameParts.push(suffix);
     }
+    const defaultName = nameParts.join(' ');
+
+    if (
+      !this.faker.definitions.name.name ||
+      this.faker.definitions.name.name.length === 0
+    ) {
+      return defaultName;
+    }
+    if (gender || firstName || lastName) {
+      return defaultName;
+    }
+
+    const fullNamePattern = this.faker.helpers.arrayElement(
+      this.faker.definitions.name.name
+    );
+
+    const fullName = this.faker.helpers.mustache(fullNamePattern, {
+      'name.gender': () => this.gender(),
+      'name.binary_gender': () => this.gender(true),
+      'name.prefix': () => this.prefix(sex),
+      'name.female_prefix': () => this.prefix(sex),
+      'name.male_prefix': () => this.prefix(sex),
+      'name.first_name': () => (firstName ? firstName : this.firstName(sex)),
+      'name.female_first_name': () =>
+        firstName ? firstName : this.firstName(sex ? sex : 'female'),
+      'name.male_first_name': () =>
+        firstName ? firstName : this.firstName(sex ? sex : 'male'),
+      'name.middle_name': () => this.middleName(sex),
+      'name.female_middle_name': () => this.middleName(sex ? sex : 'female'),
+      'name.male_middle_name': () => this.middleName(sex ? sex : 'male'),
+      'name.last_name': () => (lastName ? lastName : this.lastName(sex)),
+      'name.female_last_name': () =>
+        lastName ? lastName : this.lastName(sex ? sex : 'female'),
+      'name.male_last_name': () =>
+        lastName ? lastName : this.lastName(sex ? sex : 'male'),
+      'name.suffix': () => (suffix ? suffix : this.suffix()),
+    });
 
-    return nameParts.join(' ');
+    return fullName;
   }
 
   /**

test/name.spec.ts

@@ -243,7 +243,6 @@ describe('name', () => {
 
         it('should return a name with firstName and lastName', () => {
           const fullName = faker.name.fullName();
-
           expect(fullName).toBeTypeOf('string');
           expect(fullName).toContain(' ');
         });
@@ -327,6 +326,21 @@ describe('name', () => {
             expect(male_specific).toContain(part);
           }
         });
+
+        it('If fullNamePattern is defined, it should be configured accordingly.', () => {
+          faker.locale = 'ja';
+
+          const fullName = faker.name.fullName();
+          const male_specific = [
+            ...faker.definitions.name.female_first_name,
+            ...faker.definitions.name.male_first_name,
+            ...faker.definitions.name.last_name,
+          ];
+          const parts = fullName.split(' ');
+          for (const part of parts) {
+            expect(male_specific).toContain(part);
+          }
+        });
       });
 
       describe('gender()', () => {