refactor(person)!: rename name module (#1445)

Co-authored-by: ST-DDT <[email protected]>

5 files changed, 64 insertions, 59 deletions

diff --git a/src/modules/git/index.ts b/src/modules/git/index.ts
index d92e3454..cd9e7de0 100644
--- a/src/modules/git/index.ts
+++ b/src/modules/git/index.ts
@@ -65,7 +65,7 @@ export class GitModule {
     }
 
     lines.push(
-      `Author: ${this.faker.name.firstName()} ${this.faker.name.lastName()} <${this.faker.internet.email()}>`,
+      `Author: ${this.faker.person.firstName()} ${this.faker.person.lastName()} <${this.faker.internet.email()}>`,
       `Date: ${this.faker.date.recent().toString()}`,
       '',
       `\xa0\xa0\xa0\xa0${this.commitMessage()}`,
diff --git a/src/modules/helpers/index.ts b/src/modules/helpers/index.ts
index 5f90027d..bd765802 100644
--- a/src/modules/helpers/index.ts
+++ b/src/modules/helpers/index.ts
@@ -276,7 +276,7 @@ export class HelpersModule {
    *
    * @example
    * faker.helpers.uniqueArray(faker.random.word, 50)
-   * faker.helpers.uniqueArray(faker.definitions.name.first_name, 6)
+   * faker.helpers.uniqueArray(faker.definitions.person.first_name, 6)
    * faker.helpers.uniqueArray(["Hello", "World", "Goodbye"], 2)
    *
    * @since 6.0.0
@@ -478,10 +478,10 @@ export class HelpersModule {
    * It checks the given string for placeholders and replaces them by calling faker methods:
    *
    * ```js
-   * const hello = faker.helpers.fake('Hi, my name is {{name.firstName}} {{name.lastName}}!')
+   * const hello = faker.helpers.fake('Hi, my name is {{person.firstName}} {{person.lastName}}!')
    * ```
    *
-   * This would use the `faker.name.firstName()` and `faker.name.lastName()` method to resolve the placeholders respectively.
+   * This would use the `faker.person.firstName()` and `faker.person.lastName()` method to resolve the placeholders respectively.
    *
    * It is also possible to provide parameters. At first, they will be parsed as json,
    * and if that isn't possible, we will fall back to string:
@@ -499,10 +499,10 @@ export class HelpersModule {
    * @see faker.helpers.mustache() to use custom functions for resolution.
    *
    * @example
-   * faker.helpers.fake('{{name.lastName}}') // 'Barrows'
-   * faker.helpers.fake('{{name.lastName}}, {{name.firstName}} {{name.suffix}}') // 'Durgan, Noe MD'
+   * faker.helpers.fake('{{person.lastName}}') // 'Barrows'
+   * faker.helpers.fake('{{person.lastName}}, {{person.firstName}} {{person.suffix}}') // 'Durgan, Noe MD'
    * faker.helpers.fake('This is static test.') // 'This is static test.'
-   * faker.helpers.fake('Good Morning {{name.firstName}}!') // 'Good Morning Estelle!'
+   * faker.helpers.fake('Good Morning {{person.firstName}}!') // 'Good Morning Estelle!'
    * faker.helpers.fake('You can call me at {{phone.number(!## ### #####!)}}.') // 'You can call me at 202 555 973722.'
    * faker.helpers.fake('I flipped the coin and got: {{helpers.arrayElement(["heads", "tails"])}}') // 'I flipped the coin and got: tails'
    *
@@ -524,7 +524,7 @@ export class HelpersModule {
     }
 
     // extract method name from between the {{ }} that we found
-    // for example: {{name.firstName}}
+    // for example: {{person.firstName}}
     const token = str.substring(start + 2, end + 2);
     let method = token.replace('}}', '').replace('{{', '');
 
@@ -614,7 +614,7 @@ export class HelpersModule {
    * @param options.store The store of unique entries. Defaults to a global store.
    *
    * @example
-   * faker.helpers.unique(faker.name.firstName) // 'Corbin'
+   * faker.helpers.unique(faker.person.firstName) // 'Corbin'
    *
    * @since 7.5.0
    */
diff --git a/src/modules/internet/index.ts b/src/modules/internet/index.ts
index 3c4eedee..1c7e85cc 100644
--- a/src/modules/internet/index.ts
+++ b/src/modules/internet/index.ts
@@ -136,8 +136,8 @@ export class InternetModule {
    */
   userName(firstName?: string, lastName?: string): string {
     let result: string;
-    firstName = firstName || this.faker.name.firstName();
-    lastName = lastName || this.faker.name.lastName();
+    firstName = firstName || this.faker.person.firstName();
+    lastName = lastName || this.faker.person.lastName();
     switch (this.faker.datatype.number(2)) {
       case 0:
         result = `${firstName}${this.faker.datatype.number(99)}`;
diff --git a/src/modules/name/index.ts b/src/modules/person/index.ts
index 99d25f8f..9938a077 100644
--- a/src/modules/name/index.ts
+++ b/src/modules/person/index.ts
@@ -58,10 +58,10 @@ function selectDefinition(
 /**
  * Module to generate people's names and titles.
  */
-export class NameModule {
+export class PersonModule {
   constructor(private readonly faker: Faker) {
     // Bind `this` so namespaced is working correctly
-    for (const name of Object.getOwnPropertyNames(NameModule.prototype)) {
+    for (const name of Object.getOwnPropertyNames(PersonModule.prototype)) {
       if (name === 'constructor' || typeof this[name] !== 'function') {
         continue;
       }
@@ -76,15 +76,15 @@ export class NameModule {
    * Can be either `'female'` or `'male'`.
    *
    * @example
-   * faker.name.firstName() // 'Antwan'
-   * faker.name.firstName('female') // 'Victoria'
-   * faker.name.firstName('male') // 'Tom'
+   * faker.person.firstName() // 'Antwan'
+   * faker.person.firstName('female') // 'Victoria'
+   * faker.person.firstName('male') // 'Tom'
    *
    * @since 2.0.1
    */
   firstName(sex?: SexType): string {
     const { first_name, female_first_name, male_first_name } =
-      this.faker.definitions.name;
+      this.faker.definitions.person;
 
     return selectDefinition(this.faker, sex, {
       generic: first_name,
@@ -100,15 +100,15 @@ export class NameModule {
    * Can be either `'female'` or `'male'`.
    *
    * @example
-   * faker.name.lastName() // 'Hauck'
-   * faker.name.lastName('female') // 'Grady'
-   * faker.name.lastName('male') // 'Barton'
+   * faker.person.lastName() // 'Hauck'
+   * faker.person.lastName('female') // 'Grady'
+   * faker.person.lastName('male') // 'Barton'
    *
    * @since 2.0.1
    */
   lastName(sex?: SexType): string {
     const { last_name, female_last_name, male_last_name } =
-      this.faker.definitions.name;
+      this.faker.definitions.person;
 
     return selectDefinition(this.faker, sex, {
       generic: last_name,
@@ -124,15 +124,15 @@ export class NameModule {
    * Can be either `'female'` or `'male'`.
    *
    * @example
-   * faker.name.middleName() // 'James'
-   * faker.name.middleName('female') // 'Eloise'
-   * faker.name.middleName('male') // 'Asher'
+   * faker.person.middleName() // 'James'
+   * faker.person.middleName('female') // 'Eloise'
+   * faker.person.middleName('male') // 'Asher'
    *
    * @since 5.2.0
    */
   middleName(sex?: SexType): string {
     const { middle_name, female_middle_name, male_middle_name } =
-      this.faker.definitions.name;
+      this.faker.definitions.person;
 
     return selectDefinition(this.faker, sex, {
       generic: middle_name,
@@ -150,11 +150,11 @@ export class NameModule {
    * @param options.sex The optional sex to use. Can be either `'female'` or `'male'`.
    *
    * @example
-   * faker.name.fullName() // 'Allen Brown'
-   * faker.name.fullName({ firstName: 'Joann' }) // 'Joann Osinski'
-   * faker.name.fullName({ firstName: 'Marcella', sex: 'female' }) // 'Mrs. Marcella Huels'
-   * faker.name.fullName({ lastName: 'Beer' }) // 'Mr. Alfonso Beer'
-   * faker.name.fullName({ sex: 'male' }) // 'Fernando Schaefer'
+   * faker.person.fullName() // 'Allen Brown'
+   * faker.person.fullName({ firstName: 'Joann' }) // 'Joann Osinski'
+   * faker.person.fullName({ firstName: 'Marcella', sex: 'female' }) // 'Mrs. Marcella Huels'
+   * faker.person.fullName({ lastName: 'Beer' }) // 'Mr. Alfonso Beer'
+   * faker.person.fullName({ sex: 'male' }) // 'Fernando Schaefer'
    *
    * @since 7.4.0
    */
@@ -197,39 +197,41 @@ export class NameModule {
   /**
    * Returns a random gender.
    *
-   * @see faker.name.sex() if you would like to generate binary-gender value
+   * @see faker.person.sex() if you would like to generate binary-gender value
    *
    * @example
-   * faker.name.gender() // 'Trans*Man'
+   * faker.person.gender() // 'Trans*Man'
    *
    * @since 5.0.0
    */
   gender(): string {
-    return this.faker.helpers.arrayElement(this.faker.definitions.name.gender);
+    return this.faker.helpers.arrayElement(
+      this.faker.definitions.person.gender
+    );
   }
 
   /**
    * Returns a random sex.
    *
    * Output of this method is localised, so it should not be used to fill the parameter `sex`
-   * available in some other modules for example `faker.name.firstName()`.
+   * available in some other modules for example `faker.person.firstName()`.
    *
-   * @see faker.name.gender() if you would like to generate gender related values.
+   * @see faker.person.gender() if you would like to generate gender related values.
    *
    * @example
-   * faker.name.sex() // 'female'
+   * faker.person.sex() // 'female'
    *
    * @since 7.5.0
    */
   sex(): string {
-    return this.faker.helpers.arrayElement(this.faker.definitions.name.sex);
+    return this.faker.helpers.arrayElement(this.faker.definitions.person.sex);
   }
 
   /**
    * Returns a random sex type.
    *
    * @example
-   * faker.name.sexType() // Sex.Female
+   * faker.person.sexType() // Sex.Female
    *
    * @since 7.5.0
    */
@@ -238,19 +240,20 @@ export class NameModule {
   }
 
   /**
-   * Returns a random name prefix.
+   * Returns a random person prefix.
    *
    * @param sex The optional sex to use. Can be either `'female'` or `'male'`.
    *
    * @example
-   * faker.name.prefix() // 'Miss'
-   * faker.name.prefix('female') // 'Ms.'
-   * faker.name.prefix('male') // 'Mr.'
+   * faker.person.prefix() // 'Miss'
+   * faker.person.prefix('female') // 'Ms.'
+   * faker.person.prefix('male') // 'Mr.'
    *
    * @since 2.0.1
    */
   prefix(sex?: SexType): string {
-    const { prefix, female_prefix, male_prefix } = this.faker.definitions.name;
+    const { prefix, female_prefix, male_prefix } =
+      this.faker.definitions.person;
 
     return selectDefinition(this.faker, sex, {
       generic: prefix,
@@ -260,23 +263,25 @@ export class NameModule {
   }
 
   /**
-   * Returns a random name suffix.
+   * Returns a random person suffix.
    *
    * @example
-   * faker.name.suffix() // 'DDS'
+   * faker.person.suffix() // 'DDS'
    *
    * @since 2.0.1
    */
   suffix(): string {
     // TODO @Shinigami92 2022-03-21: Add female_suffix and male_suffix
-    return this.faker.helpers.arrayElement(this.faker.definitions.name.suffix);
+    return this.faker.helpers.arrayElement(
+      this.faker.definitions.person.suffix
+    );
   }
 
   /**
    * Generates a random job title.
    *
    * @example
-   * faker.name.jobTitle() // 'Global Accounts Engineer'
+   * faker.person.jobTitle() // 'Global Accounts Engineer'
    *
    * @since 3.0.0
    */
@@ -288,13 +293,13 @@ export class NameModule {
    * Generates a random job descriptor.
    *
    * @example
-   * faker.name.jobDescriptor() // 'Customer'
+   * faker.person.jobDescriptor() // 'Customer'
    *
    * @since 3.0.0
    */
   jobDescriptor(): string {
     return this.faker.helpers.arrayElement(
-      this.faker.definitions.name.title.descriptor
+      this.faker.definitions.person.title.descriptor
     );
   }
 
@@ -302,13 +307,13 @@ export class NameModule {
    * Generates a random job area.
    *
    * @example
-   * faker.name.jobArea() // 'Brand'
+   * faker.person.jobArea() // 'Brand'
    *
    * @since 3.0.0
    */
   jobArea(): string {
     return this.faker.helpers.arrayElement(
-      this.faker.definitions.name.title.level
+      this.faker.definitions.person.title.level
     );
   }
 
@@ -316,13 +321,13 @@ export class NameModule {
    * Generates a random job type.
    *
    * @example
-   * faker.name.jobType() // 'Assistant'
+   * faker.person.jobType() // 'Assistant'
    *
    * @since 3.0.0
    */
   jobType(): string {
     return this.faker.helpers.arrayElement(
-      this.faker.definitions.name.title.job
+      this.faker.definitions.person.title.job
     );
   }
 }
diff --git a/src/modules/random/index.ts b/src/modules/random/index.ts
index 7ce4df75..e79a2e70 100644
--- a/src/modules/random/index.ts
+++ b/src/modules/random/index.ts
@@ -155,12 +155,12 @@ export class RandomModule {
 
       this.faker.music.genre,
 
-      this.faker.name.gender,
-      this.faker.name.jobArea,
-      this.faker.name.jobDescriptor,
-      this.faker.name.jobTitle,
-      this.faker.name.jobType,
-      this.faker.name.sex,
+      this.faker.person.gender,
+      this.faker.person.jobArea,
+      this.faker.person.jobDescriptor,
+      this.faker.person.jobTitle,
+      this.faker.person.jobType,
+      this.faker.person.sex,
 
       () => this.faker.science.chemicalElement().name,
       () => this.faker.science.unit().name,