2623 add option to exclude emoji

src/definitions/person.ts

@@ -1,3 +1,4 @@
+import type { BioType } from '../modules/person';
 import type { LocaleEntry } from './definitions';
 
 /**
@@ -37,7 +38,7 @@ export type PersonDefinition = LocaleEntry<{
   male_last_name_pattern: Array<{ value: string; weight: number }>;
   female_last_name_pattern: Array<{ value: string; weight: number }>;
 
-  bio_pattern: string[];
+  bio_pattern: Record<BioType, string[]>;
 
   job_descriptor: string[];
   job_area: string[];

src/locales/en/person/bio_pattern.ts

@@ -1,10 +1,16 @@
-export default [
-  '{{person.bio_part}}',
-  '{{person.bio_part}}, {{person.bio_part}}',
-  '{{person.bio_part}}, {{person.bio_part}}, {{person.bio_part}}',
-  '{{person.bio_part}}, {{person.bio_part}}, {{person.bio_part}} {{internet.emoji}}',
-  '{{word.noun}} {{person.bio_supporter}}',
-  '{{word.noun}} {{person.bio_supporter}}  {{internet.emoji}}',
-  '{{word.noun}} {{person.bio_supporter}}, {{person.bio_part}}',
-  '{{word.noun}} {{person.bio_supporter}}, {{person.bio_part}} {{internet.emoji}}',
-];
+export default {
+  emoji: [
+    '{{person.bio_part}}, {{internet.emoji}}',
+    '{{person.bio_part}}, {{person.bio_part}}, {{internet.emoji}}',
+    '{{person.bio_part}}, {{person.bio_part}}, {{person.bio_part}} {{internet.emoji}}',
+    '{{word.noun}} {{person.bio_supporter}}  {{internet.emoji}}',
+    '{{word.noun}} {{person.bio_supporter}}, {{person.bio_part}} {{internet.emoji}}',
+  ],
+  text: [
+    '{{person.bio_part}}',
+    '{{person.bio_part}}, {{person.bio_part}}',
+    '{{person.bio_part}}, {{person.bio_part}}, {{person.bio_part}}',
+    '{{word.noun}} {{person.bio_supporter}}',
+    '{{word.noun}} {{person.bio_supporter}}, {{person.bio_part}}',
+  ],
+};

src/locales/eo/person/bio_pattern.ts

@@ -1,8 +1,12 @@
-export default [
-  '{{person.bio_part}}',
-  '{{person.bio_part}} {{internet.emoji}}',
-  '{{person.bio_part}}, {{person.bio_part}}',
-  '{{person.bio_part}}, {{person.bio_part}} {{internet.emoji}}',
-  '{{person.bio_part}}, {{person.bio_part}}, {{person.bio_part}}',
-  '{{person.bio_part}}, {{person.bio_part}}, {{person.bio_part}} {{internet.emoji}}',
-];
+export default {
+  emoji: [
+    '{{person.bio_part}} {{internet.emoji}}',
+    '{{person.bio_part}}, {{person.bio_part}} {{internet.emoji}}',
+    '{{person.bio_part}}, {{person.bio_part}}, {{person.bio_part}} {{internet.emoji}}',
+  ],
+  text: [
+    '{{person.bio_part}}',
+    '{{person.bio_part}}, {{person.bio_part}}',
+    '{{person.bio_part}}, {{person.bio_part}}, {{person.bio_part}}',
+  ],
+};

src/locales/zh_CN/person/bio_pattern.ts

@@ -1,10 +1,14 @@
-export default [
-  '{{person.bio_part}}',
-  '{{person.bio_part}}，{{person.bio_part}}',
-  '{{person.bio_part}}，{{person.bio_part}}，{{person.bio_part}}',
-  '{{person.bio_part}}，{{person.bio_part}}，{{person.bio_part}}{{internet.emoji}}',
-  '{{word.noun}}{{person.bio_supporter}}',
-  '{{word.noun}}{{person.bio_supporter}}{{internet.emoji}}',
-  '{{word.noun}}{{person.bio_supporter}}，{{person.bio_part}}',
-  '{{word.noun}}{{person.bio_supporter}}，{{person.bio_part}}{{internet.emoji}}',
-];
+export default {
+  emoji: [
+    '{{person.bio_part}}，{{person.bio_part}}，{{person.bio_part}}{{internet.emoji}}',
+    '{{word.noun}}{{person.bio_supporter}}{{internet.emoji}}',
+    '{{word.noun}}{{person.bio_supporter}}，{{person.bio_part}}{{internet.emoji}}',
+  ],
+  text: [
+    '{{person.bio_part}}',
+    '{{person.bio_part}}，{{person.bio_part}}',
+    '{{person.bio_part}}，{{person.bio_part}}，{{person.bio_part}}',
+    '{{word.noun}}{{person.bio_supporter}}',
+    '{{word.noun}}{{person.bio_supporter}}，{{person.bio_part}}',
+  ],
+};

src/modules/person/index.ts

@@ -9,6 +9,8 @@ export enum Sex {
 
 export type SexType = `${Sex}`;
 
+export type BioType = 'emoji' | 'text';
+
 /**
  * Select a definition based on given sex.
  *
@@ -312,15 +314,34 @@ export class PersonModule extends ModuleBase {
   /**
    * Returns a random short biography
    *
+   * @param options Options object.
+   * @param options.types A list of pattern types that can be generated. Possible values are `'emoji'`, `'text'`. By default, any pattern will be included.
+   *
    * @example
    * faker.person.bio() // 'oatmeal advocate, veteran 🐠'
+   * faker.person.bio({ types: ['text'] }) // 'oatmeal advocate, veteran'
    *
    * @since 8.0.0
    */
-  bio(): string {
-    const { bio_pattern } = this.faker.definitions.person;
-
-    return this.faker.helpers.fake(bio_pattern);
+  bio(
+    options: {
+      /**
+       * A list of the bio pattern types that should be used.
+       *
+       * @default Object.keys(faker.definitions.person.bio_pattern)
+       */
+      types?: ReadonlyArray<BioType>;
+    } = {}
+  ): string {
+    const {
+      types = Object.keys(
+        this.faker.definitions.person.bio_pattern
+      ) as BioType[],
+    } = options;
+    const bioType = this.faker.helpers.arrayElement(types);
+    return this.faker.helpers.fake(
+      this.faker.definitions.person.bio_pattern[bioType]
+    );
   }
 
   /**

test/modules/__snapshots__/person.spec.ts.snap

@@ -1,6 +1,8 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`person > 42 > bio 1`] = `"traveler, philosopher, model"`;
+exports[`person > 42 > bio > noArgs 1`] = `"negotiation devotee, creator 💛"`;
+
+exports[`person > 42 > bio > with options 1`] = `"traveler, philosopher, 🏩"`;
 
 exports[`person > 42 > firstName > noArgs 1`] = `"Garnet"`;
 
@@ -50,7 +52,9 @@ exports[`person > 42 > suffix > with sex 1`] = `"III"`;
 
 exports[`person > 42 > zodiacSign 1`] = `"Gemini"`;
 
-exports[`person > 1211 > bio 1`] = `"decongestant supporter, parent 🎲"`;
+exports[`person > 1211 > bio > noArgs 1`] = `"yogurt junkie, patriot"`;
+
+exports[`person > 1211 > bio > with options 1`] = `"decongestant supporter, parent 🎲"`;
 
 exports[`person > 1211 > firstName > noArgs 1`] = `"Tito"`;
 
@@ -100,7 +104,9 @@ exports[`person > 1211 > suffix > with sex 1`] = `"DVM"`;
 
 exports[`person > 1211 > zodiacSign 1`] = `"Capricorn"`;
 
-exports[`person > 1337 > bio 1`] = `"creator, engineer, friend"`;
+exports[`person > 1337 > bio > noArgs 1`] = `"engineer, 🧇"`;
+
+exports[`person > 1337 > bio > with options 1`] = `"creator, engineer, 🧇"`;
 
 exports[`person > 1337 > firstName > noArgs 1`] = `"Devyn"`;
 

test/modules/person.spec.ts

@@ -13,8 +13,7 @@ describe('person', () => {
       'jobTitle',
       'jobDescriptor',
       'jobArea',
-      'jobType',
-      'bio'
+      'jobType'
     );
 
     t.describeEach(
@@ -39,6 +38,10 @@ describe('person', () => {
     });
 
     t.it('zodiacSign');
+
+    t.describe('bio', (t) => {
+      t.it('noArgs').it('with options', { types: ['emoji'] });
+    });
   });
 
   describe.each(times(NON_SEEDED_BASED_RUN).map(() => faker.seed()))(