feat(person): add short bio (#1696)

faker-js · Dec 31, 2022 · 2a2e054 · 2a2e054
1 parent 351f8f0
commit 2a2e054
Show file tree

Hide file tree

Showing 8 changed files with 92 additions and 1 deletion.
diff --git a/src/definitions/person.ts b/src/definitions/person.ts
@@ -30,6 +30,8 @@ export type PersonDefinitions = LocaleEntry<{
    */
   name: string[];
 
+  bio_patterns?: string[];
+
   title: PersonTitleDefinitions;
 
   western_zodiac_sign: string[];

diff --git a/src/locales/en/person/bio_part.ts b/src/locales/en/person/bio_part.ts
@@ -0,0 +1,43 @@
+export default [
+  'activist',
+  'artist',
+  'author',
+  'blogger',
+  'business owner',
+  'coach',
+  'creator',
+  'designer',
+  'developer',
+  'dreamer',
+  'educator',
+  'engineer',
+  'entrepreneur',
+  'environmentalist',
+  'film lover',
+  'filmmaker',
+  'foodie',
+  'founder',
+  'friend',
+  'gamer',
+  'geek',
+  'grad',
+  'inventor',
+  'leader',
+  'model',
+  'musician',
+  'nerd',
+  'parent',
+  'patriot',
+  'person',
+  'philosopher',
+  'photographer',
+  'public speaker',
+  'scientist',
+  'singer',
+  'streamer',
+  'student',
+  'teacher',
+  'traveler',
+  'veteran',
+  'writer',
+];
diff --git a/src/locales/en/person/bio_patterns.ts b/src/locales/en/person/bio_patterns.ts
@@ -0,0 +1,10 @@
+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}}',
+];
diff --git a/src/locales/en/person/bio_supporter.ts b/src/locales/en/person/bio_supporter.ts
@@ -0,0 +1,9 @@
+export default [
+  'advocate',
+  'devotee',
+  'enthusiast',
+  'fan',
+  'junkie',
+  'lover',
+  'supporter',
+];
diff --git a/src/locales/en/person/index.ts b/src/locales/en/person/index.ts
@@ -3,6 +3,9 @@
  * Run 'pnpm run generate:locales' to update.
  */
 import type { PersonDefinitions } from '../../..';
+import bio_part from './bio_part';
+import bio_patterns from './bio_patterns';
+import bio_supporter from './bio_supporter';
 import female_first_name from './female_first_name';
 import female_middle_name from './female_middle_name';
 import first_name from './first_name';
@@ -19,6 +22,9 @@ import title from './title';
 import western_zodiac_sign from './western_zodiac_sign';
 
 const person: PersonDefinitions = {
+  bio_part,
+  bio_patterns,
+  bio_supporter,
   female_first_name,
   female_middle_name,
   first_name,

diff --git a/src/modules/person/index.ts b/src/modules/person/index.ts
@@ -240,6 +240,20 @@ export class PersonModule {
     return this.faker.helpers.objectValue(Sex);
   }
 
+  /**
+   * Returns a random short biography
+   *
+   * @example
+   * faker.person.bio() // 'oatmeal advocate, veteran 🐠'
+   *
+   * @since 8.0.0
+   */
+  bio(): string {
+    const { bio_patterns } = this.faker.definitions.person;
+
+    return this.faker.helpers.fake(bio_patterns);
+  }
+
   /**
    * Returns a random person prefix.
    *

diff --git a/test/__snapshots__/person.spec.ts.snap b/test/__snapshots__/person.spec.ts.snap
@@ -1,5 +1,7 @@
 // Vitest Snapshot v1
 
+exports[`person > 42 > bio 1`] = `"public speaker, traveler, designer"`;
+
 exports[`person > 42 > firstName > noArgs 1`] = `"Garnet"`;
 
 exports[`person > 42 > firstName > with sex 1`] = `"Glen"`;
@@ -48,6 +50,8 @@ exports[`person > 42 > suffix > with sex 1`] = `"III"`;
 
 exports[`person > 42 > zodiacSign 1`] = `"Gemini"`;
 
+exports[`person > 1211 > bio 1`] = `"infusion supporter, photographer 🙆‍♀️"`;
+
 exports[`person > 1211 > firstName > noArgs 1`] = `"Tito"`;
 
 exports[`person > 1211 > firstName > with sex 1`] = `"Percy"`;
@@ -96,6 +100,8 @@ exports[`person > 1211 > suffix > with sex 1`] = `"DVM"`;
 
 exports[`person > 1211 > zodiacSign 1`] = `"Capricorn"`;
 
+exports[`person > 1337 > bio 1`] = `"inventor, creator, developer"`;
+
 exports[`person > 1337 > firstName > noArgs 1`] = `"Devyn"`;
 
 exports[`person > 1337 > firstName > with sex 1`] = `"Ray"`;

diff --git a/test/person.spec.ts b/test/person.spec.ts
@@ -17,7 +17,8 @@ describe('person', () => {
       'jobTitle',
       'jobDescriptor',
       'jobArea',
-      'jobType'
+      'jobType',
+      'bio'
     );
 
     t.describeEach(