Merge branch 'next' into refactor/address/lat-long-return-type

Author: Shinigami92

.github/workflows/ci.yml

@@ -33,7 +33,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Install pnpm
-        uses: pnpm/[email protected].2
+        uses: pnpm/[email protected].3
         with:
           version: 7
 
@@ -62,7 +62,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Install pnpm
-        uses: pnpm/[email protected].2
+        uses: pnpm/[email protected].3
         with:
           version: 7
 
@@ -90,7 +90,7 @@ jobs:
           fetch-depth: 0
 
       - name: Install pnpm
-        uses: pnpm/[email protected].2
+        uses: pnpm/[email protected].3
         with:
           version: 7
 
@@ -121,7 +121,7 @@ jobs:
           fetch-depth: 0
 
       - name: Install pnpm
-        uses: pnpm/[email protected].2
+        uses: pnpm/[email protected].3
         with:
           version: 7
 
@@ -149,7 +149,7 @@ jobs:
           fetch-depth: 0
 
       - name: Install pnpm
-        uses: pnpm/[email protected].2
+        uses: pnpm/[email protected].3
         with:
           version: 7
 
@@ -177,7 +177,7 @@ jobs:
           fetch-depth: 0
 
       - name: Install pnpm
-        uses: pnpm/[email protected].2
+        uses: pnpm/[email protected].3
         with:
           version: 7
 

.github/workflows/pr.yml

@@ -19,7 +19,7 @@ jobs:
           fetch-depth: 0
 
       - name: Install pnpm
-        uses: pnpm/[email protected].2
+        uses: pnpm/[email protected].3
         with:
           version: 7
 

CONTRIBUTING.md

@@ -321,9 +321,11 @@ This rule improves the comments readability by grouping equivalent tags and maki
 
 ```ts
 /**
- * This is a bad JSDoc block, because it has no linebreaks between sections.
+ * This is a good JSDoc block, because it follows the Faker preferences.
+ *
  * @param bar The first argument.
  * @param baz The second argument.
+ *
  * @example foo(1, 1) // [1, 1]
  * @example foo(13, 56) // [13, 56]
  */
@@ -337,11 +339,9 @@ function foo(bar: number, baz: number): [number, number] {
 
 ```ts
 /**
- * This is a good JSDoc block, because it follows the Faker preferences.
- *
+ * This is a bad JSDoc block, because it has no linebreaks between sections.
  * @param bar The first argument.
  * @param baz The second argument.
- *
  * @example foo(1, 1) // [1, 1]
  * @example foo(13, 56) // [13, 56]
  */

README.md

@@ -88,7 +88,7 @@ The API covers the following modules:
 | Internet | `faker.internet.domainName()`                 | muddy-neuropathologist.net                                                                         |
 | Lorem    | `faker.lorem.paragraph()`                     | Porro nulla id vero perspiciatis nulla nihil. ...                                                  |
 | Music    | `faker.music.genre()`                         | R&B                                                                                                |
-| Name     | `faker.name.firstName()`                      | Cameron                                                                                            |
+| Person   | `faker.person.firstName()`                    | Cameron                                                                                            |
 | Phone    | `faker.phone.phoneNumber()`                   | +1 291-299-0192                                                                                    |
 | Random   | `faker.random.locale()`                       | fr_CA                                                                                              |
 | Science  | `faker.science.unit()`                        | `{ name: 'meter', symbol: 'm' }`                                                                   |
@@ -103,7 +103,7 @@ Faker contains a generator method `faker.helpers.fake` for combining faker API m
 ```ts
 console.log(
   faker.helpers.fake(
-    'Hello {{name.prefix}} {{name.lastName}}, how are you today?'
+    'Hello {{person.prefix}} {{person.lastName}}, how are you today?'
   )
 );
 ```

docs/.vitepress/api-pages.ts

@@ -10,22 +10,19 @@ export const apiPages = [
   { text: 'Database', link: '/api/database.html' },
   { text: 'Datatype', link: '/api/datatype.html' },
   { text: 'Date', link: '/api/date.html' },
-  { text: 'Fake', link: '/api/fake.html' },
   { text: 'Finance', link: '/api/finance.html' },
   { text: 'Git', link: '/api/git.html' },
   { text: 'Hacker', link: '/api/hacker.html' },
   { text: 'Helpers', link: '/api/helpers.html' },
   { text: 'Image', link: '/api/image.html' },
   { text: 'Internet', link: '/api/internet.html' },
   { text: 'Lorem', link: '/api/lorem.html' },
-  { text: 'Mersenne', link: '/api/mersenne.html' },
   { text: 'Music', link: '/api/music.html' },
-  { text: 'Name', link: '/api/name.html' },
+  { text: 'Person', link: '/api/person.html' },
   { text: 'Phone', link: '/api/phone.html' },
   { text: 'Random', link: '/api/random.html' },
   { text: 'Science', link: '/api/science.html' },
   { text: 'System', link: '/api/system.html' },
-  { text: 'Unique', link: '/api/unique.html' },
   { text: 'Vehicle', link: '/api/vehicle.html' },
   { text: 'Word', link: '/api/word.html' },
 ];

docs/guide/localization.md

@@ -52,7 +52,7 @@ All locales together are around 5 MB in size.
 | en_GB       | English (Great Britain)   |
 | en_GH       | English (Ghana)           |
 | en_IE       | English (Ireland)         |
-| en_IND      | English (India)           |
+| en_IN       | English (India)           |
 | en_NG       | Nigeria (English)         |
 | en_US       | English (United States)   |
 | en_ZA       | English (South Africa)    |

docs/guide/usage.md

@@ -7,7 +7,7 @@ Using Faker is as easy as importing it from `@faker-js/faker`.
 ```js
 import { faker } from '@faker-js/faker';
 
-const randomName = faker.name.fullName(); // Rowan Nikolaus
+const randomName = faker.person.fullName(); // Rowan Nikolaus
 const randomEmail = faker.internet.email(); // [email protected]
 ```
 
@@ -16,7 +16,7 @@ Or if you using CommonJS
 ```js
 const { faker } = require('@faker-js/faker');
 
-const randomName = faker.name.fullName(); // Rowan Nikolaus
+const randomName = faker.person.fullName(); // Rowan Nikolaus
 const randomEmail = faker.internet.email(); // [email protected]
 ```
 
@@ -27,7 +27,7 @@ const randomEmail = faker.internet.email(); // [email protected]
   import { faker } from 'https://cdn.skypack.dev/@faker-js/faker';
 
   // Caitlyn Kerluke
-  const randomName = faker.name.fullName();
+  const randomName = faker.person.fullName();
 
   // [email protected]
   const randomEmail = faker.internet.email();
@@ -43,7 +43,7 @@ Using the browser is great for experimenting 👍. However, due to all of the st
 ```js
 import { faker } from 'https://cdn.skypack.dev/@faker-js/faker';
 
-const randomName = faker.name.findName(); // Willie Bahringer
+const randomName = faker.person.findName(); // Willie Bahringer
 const randomEmail = faker.internet.email(); // [email protected]
 ```
 
@@ -120,9 +120,9 @@ function createRandomUser(): User {
     avatar: faker.image.avatar(),
     birthday: faker.date.birthdate(),
     email: faker.internet.email(),
-    firstName: faker.name.firstName(),
-    lastName: faker.name.lastName(),
-    sex: faker.name.sexType(),
+    firstName: faker.person.firstName(),
+    lastName: faker.person.lastName(),
+    sex: faker.person.sexType(),
     subscriptionTier: faker.helpers.arrayElement(['free', 'basic', 'business']),
   };
 }
@@ -142,9 +142,9 @@ Let's refactor our current code:
 import { faker } from '@faker-js/faker';
 
 function createRandomUser(): User {
-  const sex = this.faker.name.sexType();
-  const firstName = faker.name.firstName(sex);
-  const lastName = faker.name.lastName();
+  const sex = this.faker.person.sexType();
+  const firstName = faker.person.firstName(sex);
+  const lastName = faker.person.lastName();
   const email = faker.internet.email(firstName, lastName);
 
   return {
@@ -179,9 +179,9 @@ Faker has your back, with another helper method:
 import { faker } from '@faker-js/faker';
 
 function createRandomUser(): User {
-  const sex = this.faker.name.sexType();
-  const firstName = faker.name.firstName(sex);
-  const lastName = faker.name.lastName();
+  const sex = this.faker.person.sexType();
+  const firstName = faker.person.firstName(sex);
+  const lastName = faker.person.lastName();
   const email = faker.helpers.unique(faker.internet.email, [
     firstName,
     lastName,

scripts/apidoc.ts

@@ -3,7 +3,6 @@ import {
   writeApiPagesIndex,
   writeApiSearchIndex,
 } from './apidoc/apiDocsWriter';
-import { processDirectMethods } from './apidoc/directMethods';
 import { processModuleMethods } from './apidoc/moduleMethods';
 import { initMarkdownRenderer } from './apidoc/signature';
 import type { PageIndex } from './apidoc/utils';
@@ -35,7 +34,6 @@ async function build(): Promise<void> {
 
   const modulesPages: PageIndex = [];
   modulesPages.push(...processModuleMethods(project));
-  modulesPages.push(...processDirectMethods(project));
   writeApiPagesIndex(modulesPages);
 
   writeApiSearchIndex(project);

scripts/apidoc/apiDocsWriter.ts

@@ -4,7 +4,6 @@ import type { ProjectReflection } from 'typedoc';
 import { ReflectionKind } from 'typedoc';
 import type { Method } from '../../docs/.vitepress/components/api-docs/method';
 import type { APIGroup, APIItem } from '../../docs/api/api-types';
-import { selectDirectMethods } from './directMethods';
 import { extractModuleName, selectApiModules } from './moduleMethods';
 import type { PageIndex } from './utils';
 import {
@@ -78,37 +77,6 @@ export function writeApiDocsModulePage(
   writeFileSync(resolve(pathOutputDir, `${lowerModuleName}.md`), content);
 }
 
-/**
- * Writes the api page for the given method to the correct location.
- *
- * @param methodName The name of the method to write the docs for.
- * @param capitalizedMethodName The capitalized name of the method.
- */
-export function writeApiDocsDirectPage(
-  methodName: string,
-  capitalizedMethodName: string
-): void {
-  let content = `
-  <script setup>
-  import ApiDocsMethod from '../.vitepress/components/api-docs/method.vue';
-  import ${methodName} from './${methodName}.json';
-  </script>
-
-  <!-- This file is automatically generated. -->
-  <!-- Run '${scriptCommand}' to update -->
-
-  # ${capitalizedMethodName}
-
-  ## ${methodName}
-
-  <ApiDocsMethod :method="${methodName}.${methodName}" v-once />
-  `.replace(/\n +/g, '\n');
-
-  content = vitePressInFileOptions + formatMarkdown(content);
-
-  writeFileSync(resolve(pathOutputDir, `${methodName}.md`), content);
-}
-
 /**
  * Writes the api docs data to correct location.
  *
@@ -164,9 +132,8 @@ export function writeApiSearchIndex(project: ProjectReflection): void {
   apiIndex.push(moduleApiSection);
 
   const apiModules = selectApiModules(project);
-  const directMethods = selectDirectMethods(project);
 
-  moduleApiSection.items = [...apiModules, ...directMethods]
+  moduleApiSection.items = apiModules
     .map((module) => {
       const moduleName = extractModuleName(module);
       const apiSection: APIItem = {

scripts/apidoc/directMethods.ts

@@ -17,10 +17,7 @@ export function selectApiModules(
 ): DeclarationReflection[] {
   return project
     .getChildrenByKind(ReflectionKind.Class)
-    .filter((module) => faker[extractModuleFieldName(module)] != null)
-    .filter(
-      (module) => module.name !== 'FakeModule' && module.name !== 'UniqueModule'
-    );
+    .filter((module) => faker[extractModuleFieldName(module)] != null);
 }
 
 /**
@@ -41,7 +38,13 @@ export function processModuleMethods(project: ProjectReflection): PageIndex {
 }
 
 export function extractModuleName(module: DeclarationReflection): string {
-  return module.name.replace(/Module$/, '');
+  const { name } = module;
+  // TODO @ST-DDT 2022-10-16: Remove in v10.
+  // Typedoc prefers the name of the module that is exported first.
+  if (name === 'NameModule') {
+    return 'Person';
+  }
+  return name.replace(/Module$/, '');
 }
 
 function extractModuleFieldName(module: DeclarationReflection): string {

scripts/apidoc/moduleMethods.ts

@@ -57,7 +57,7 @@ const definitionsTypes: DefinitionsType = {
   internet: 'InternetDefinitions',
   lorem: 'LoremDefinitions',
   music: 'MusicDefinitions',
-  name: 'NameDefinitions',
+  person: 'PersonDefinitions',
   phone_number: 'PhoneNumberDefinitions',
   science: 'ScienceDefinitions',
   system: 'SystemDefinitions',