Merge branch 'next' into pr/matthewmayer/2505

faker-js · Feb 27, 2024 · 3943cc9 · 3943cc9
2 parents 075c0aa + 682a427
commit 3943cc9
Show file tree

Hide file tree

Showing 114 changed files with 3,496 additions and 5,940 deletions.
diff --git a/.eslintrc.js → .eslintrc.cjs b/.eslintrc.js → .eslintrc.cjs
@@ -11,7 +11,7 @@ const { readGitignoreFiles } = require('eslint-gitignore');
 module.exports = defineConfig({
   ignorePatterns: [
     ...readGitignoreFiles(),
-    '.eslintrc.js', // Skip self linting
+    '.eslintrc.cjs', // Skip self linting
   ],
   root: true,
   env: {
@@ -44,13 +44,6 @@ module.exports = defineConfig({
     'unicorn/number-literal-case': 'off', // incompatible with prettier
     'unicorn/prefer-ternary': 'off', // ternaries aren't always better
 
-    // TODO @Shinigami92 2023-09-23: prefer-at should be turned on when we drop support for Node 14.
-    'unicorn/prefer-at': 'off',
-    // TODO @Shinigami92 2023-09-23: prefer-string-replace-all should be turned on when we drop support for Node 14.
-    'unicorn/prefer-string-replace-all': 'off',
-    // TODO @ST-DDT 2023-10-28: The following rule should be turned on when we switch to esm.
-    'unicorn/prefer-top-level-await': 'off',
-
     // TODO @Shinigami92 2023-09-23: The following rules currently conflict with our code.
     // Each rule should be checked whether it should be enabled/configured and the problems fixed, or stay disabled permanently.
     'unicorn/better-regex': 'off',
@@ -59,7 +52,6 @@ module.exports = defineConfig({
     'unicorn/no-array-callback-reference': 'off',
     'unicorn/no-await-expression-member': 'off',
     'unicorn/no-object-as-default-parameter': 'off',
-    'unicorn/no-useless-switch-case': 'off',
     'unicorn/numeric-separators-style': 'off',
     'unicorn/prefer-export-from': 'off',
     'unicorn/prefer-string-slice': 'off',

diff --git a/.gitattributes b/.gitattributes
@@ -1 +1,2 @@
-* -crlf
+* text eol=lf
+*.png binary
diff --git a/.github/renovate.json5 b/.github/renovate.json5
@@ -8,6 +8,9 @@
     "helpers:pinGitHubActionDigests"
   ],
   "labels": ["c: dependencies"],
+  "lockFileMaintenance": {
+    "enabled": true
+  },
   "reviewersFromCodeOwners": true,
   "rangeStrategy": "bump",
   "packageRules": [

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -14,44 +14,24 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest]
-        node_version: [14, 16, 18, 20]
-        include:
-          - os: macos-latest
-            node_version: 16
-          - os: macos-latest
-            node_version: 18
-          - os: macos-latest
-            node_version: 20
-          - os: windows-latest
-            node_version: 16
-          - os: windows-latest
-            node_version: 18
-          - os: windows-latest
-            node_version: 20
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        node_version: [18, 20]
       fail-fast: false
     timeout-minutes: 10
 
     name: 'Build & Unit Test: node-${{ matrix.node_version }}, ${{ matrix.os }}'
     steps:
       - name: Checkout
-        uses: actions/checkout@1e31de5234b9f8995739874a8ce0492dc87873e2 # v4.0.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
         with:
           # Required for docs/versions tests
           fetch-depth: 0
 
-      - name: Install pnpm (node 14, pnpm 7)
-        if: matrix.node_version == 14
-        uses: pnpm/action-setup@d882d12c64e032187b2edb46d3a0d003b7a43598 # v2.4.0
-        with:
-          version: 7
-
       - name: Install pnpm
-        if: matrix.node_version != 14
-        uses: pnpm/action-setup@d882d12c64e032187b2edb46d3a0d003b7a43598 # v2.4.0
+        uses: pnpm/action-setup@a3252b78c470c02df07e9d59298aecedc3ccdd6d # v3.0.0
 
       - name: Set node version to ${{ matrix.node_version }}
-        uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0
+        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
         with:
           node-version: ${{ matrix.node_version }}
           cache: 'pnpm'
@@ -90,16 +70,16 @@ jobs:
         run: date
 
       - name: Checkout
-        uses: actions/checkout@1e31de5234b9f8995739874a8ce0492dc87873e2 # v4.0.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
         with:
           # Required for docs/versions tests
           fetch-depth: 0
 
       - name: Install pnpm
-        uses: pnpm/action-setup@d882d12c64e032187b2edb46d3a0d003b7a43598 # v2.4.0
+        uses: pnpm/action-setup@a3252b78c470c02df07e9d59298aecedc3ccdd6d # v3.0.0
 
       - name: Set node version to ${{ matrix.node_version }}
-        uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0
+        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
         with:
           node-version: ${{ matrix.node_version }}
           cache: 'pnpm'
@@ -124,10 +104,10 @@ jobs:
     name: 'E2E Doc Test: node-20, ubuntu-latest'
     steps:
       - name: Checkout
-        uses: actions/checkout@1e31de5234b9f8995739874a8ce0492dc87873e2 # v4.0.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
 
       - name: Install pnpm
-        uses: pnpm/action-setup@d882d12c64e032187b2edb46d3a0d003b7a43598 # v2.4.0
+        uses: pnpm/action-setup@a3252b78c470c02df07e9d59298aecedc3ccdd6d # v3.0.0
 
       - name: Install deps
         run: pnpm install
@@ -145,15 +125,15 @@ jobs:
     name: 'Lint: node-20, ubuntu-latest'
     steps:
       - name: Checkout
-        uses: actions/checkout@1e31de5234b9f8995739874a8ce0492dc87873e2 # v4.0.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
         with:
           fetch-depth: 0
 
       - name: Install pnpm
-        uses: pnpm/action-setup@d882d12c64e032187b2edb46d3a0d003b7a43598 # v2.4.0
+        uses: pnpm/action-setup@a3252b78c470c02df07e9d59298aecedc3ccdd6d # v3.0.0
 
       - name: Set node version to 20
-        uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0
+        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
         with:
           node-version: 20
           cache: 'pnpm'
@@ -175,15 +155,15 @@ jobs:
     name: 'TS-Check: node-20, ubuntu-latest'
     steps:
       - name: Checkout
-        uses: actions/checkout@1e31de5234b9f8995739874a8ce0492dc87873e2 # v4.0.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
         with:
           fetch-depth: 0
 
       - name: Install pnpm
-        uses: pnpm/action-setup@d882d12c64e032187b2edb46d3a0d003b7a43598 # v2.4.0
+        uses: pnpm/action-setup@a3252b78c470c02df07e9d59298aecedc3ccdd6d # v3.0.0
 
       - name: Set node version to 20
-        uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0
+        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
         with:
           node-version: 20
           cache: 'pnpm'
@@ -193,6 +173,9 @@ jobs:
         env:
           CYPRESS_INSTALL_BINARY: 0
 
+      - name: Build types
+        run: pnpm run build:types
+
       - name: Check scripts
         run: pnpm run ts-check
 
@@ -202,15 +185,15 @@ jobs:
     name: 'Codecov: node-20, ubuntu-latest'
     steps:
       - name: Checkout
-        uses: actions/checkout@1e31de5234b9f8995739874a8ce0492dc87873e2 # v4.0.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
         with:
           fetch-depth: 0
 
       - name: Install pnpm
-        uses: pnpm/action-setup@d882d12c64e032187b2edb46d3a0d003b7a43598 # v2.4.0
+        uses: pnpm/action-setup@a3252b78c470c02df07e9d59298aecedc3ccdd6d # v3.0.0
 
       - name: Set node version to 20
-        uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0
+        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
         with:
           node-version: 20
           cache: 'pnpm'
@@ -227,7 +210,7 @@ jobs:
         run: pnpm vitest run --coverage
 
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@e0b68c6749509c5f83f984dd99a76a1c1a231044 # v4.0.1
+        uses: codecov/codecov-action@0cfda1dd0a4ad9efc75517f399d859cd1ea4ced1 # v4.0.2
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
diff --git a/.github/workflows/commentCodeGeneration.ts b/.github/workflows/commentCodeGeneration.ts
@@ -10,11 +10,11 @@ import type { context as ctx, GitHub } from '@actions/github/lib/utils';
  * @param context An object containing the context of the workflow run
  * @param isSuccess A boolean indicating whether the workflow was successful
  */
-module.exports = async (
+export async function script(
   github: InstanceType<typeof GitHub>,
   context: typeof ctx,
   isSuccess: boolean
-) => {
+): Promise<void> {
   const { data: comments } = await github.rest.issues.listComments({
     owner: context.repo.owner,
     repo: context.repo.repo,
@@ -45,4 +45,4 @@ module.exports = async (
       body,
     });
   }
-};
+}
diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -15,15 +15,15 @@ jobs:
       pull-requests: write
     steps:
       - name: Checkout
-        uses: actions/checkout@1e31de5234b9f8995739874a8ce0492dc87873e2 # v4.0.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
         with:
           fetch-depth: 0
 
       - name: Install pnpm
-        uses: pnpm/action-setup@d882d12c64e032187b2edb46d3a0d003b7a43598 # v2.4.0
+        uses: pnpm/action-setup@a3252b78c470c02df07e9d59298aecedc3ccdd6d # v3.0.0
 
       - name: Set node version to 20
-        uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0
+        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
         with:
           node-version: 20
           cache: 'pnpm'
@@ -41,22 +41,25 @@ jobs:
           pnpm run build
           pnpm run test -u
         continue-on-error: true
+        env:
+          CI_PREFLIGHT: true
 
       - name: Check diff
         id: diff
         run: |
           git add .
-          git diff --cached --exit-code
+          git diff --cached --name-only | sed -E 's/^(.*)$/::error file=\1,title=Diff detected::Please run `pnpm run preflight` and commit the changes./'
+          git diff --cached --name-only --exit-code
         continue-on-error: true
 
       - name: Transpile ts
-        run: pnpm exec tsc .github/workflows/commentCodeGeneration.ts --outDir .github/workflows
+        run: pnpm tsup-node .github/workflows/commentCodeGeneration.ts --format cjs --clean false --out-dir .github/workflows
 
       - name: Comment
         uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
         with:
           script: |
-            const script = require('${{ github.workspace }}/.github/workflows/commentCodeGeneration.js')
+            const { script } = require('${{ github.workspace }}/.github/workflows/commentCodeGeneration.cjs')
             await script(github, context, ${{ steps.generate.outcome == 'success' && steps.diff.outcome == 'success' }})
 
       - name: Status

diff --git a/.github/workflows/semantic-pull-request.yml b/.github/workflows/semantic-pull-request.yml
@@ -20,7 +20,7 @@ jobs:
     name: Semantic Pull Request
     steps:
       - name: Validate PR title
-        uses: amannn/action-semantic-pull-request@c3cd5d1ea3580753008872425915e343e351ab54 # v5.2.0
+        uses: amannn/action-semantic-pull-request@e9fabac35e210fea40ca5b14c0da95a099eff26f # v5.4.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:

diff --git a/.prettierrc.js b/.prettierrc.js
@@ -1,9 +1,9 @@
 // @ts-check
 
 /**
- * @type {import('prettier').Options}
+ * @type {import('prettier').Config}
  */
-module.exports = {
+export default {
   plugins: ['prettier-plugin-organize-imports'],
   singleQuote: true,
   trailingComma: 'es5',
@@ -20,6 +20,7 @@ module.exports = {
     {
       files: '*.md',
       options: {
+        // @ts-expect-error: known property
         organizeImportsSkipDestructiveCodeActions: true,
       },
     },

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -20,7 +20,7 @@ This is a shorthand for running the following scripts in order:
 
 ## Good to know
 
-- The project is being built by [esbuild](https://esbuild.github.io) (see [bundle.ts](scripts/bundle.ts))
+- The project is being built by [tsup](https://tsup.egoist.dev) (see [tsup.config.ts](tsup.config.ts))
 - The documentation is running via VitePress.
   Make sure you **build** the project before running the docs, cause some files depend on `dist`.
   Use `pnpm run docs:dev` to edit them in live mode.
@@ -49,7 +49,7 @@ Please only change files related to one module (e.g. person, location) whenever
 
 ## Building Faker
 
-The project is being built by [esbuild](https://esbuild.github.io) (see [bundle.ts](scripts/bundle.ts))
+The project is being built by [tsup](https://tsup.egoist.dev) (see [tsup.config.ts](tsup.config.ts))
 
 ```shell
 pnpm install

diff --git a/README.md b/README.md
@@ -24,11 +24,11 @@ Please proceed to the [Getting Started Guide](https://fakerjs.dev/guide/) for th
 
 For detailed API documentation, please select the version of the documentation you are looking for.
 
-|   Version    | Website                   |
-| :----------: | :------------------------ |
-| v8.\* (next) | https://next.fakerjs.dev/ |
-| v8 (stable)  | https://fakerjs.dev/      |
-|   v7 (old)   | https://v7.fakerjs.dev/   |
+|   Version   | Website                   |
+| :---------: | :------------------------ |
+|  v9 (next)  | https://next.fakerjs.dev/ |
+| v8 (stable) | https://fakerjs.dev/      |
+|  v7 (old)   | https://v7.fakerjs.dev/   |
 
 ---
 

diff --git a/docs/.vitepress/api-pages.ts b/docs/.vitepress/api-pages.ts
@@ -18,6 +18,7 @@ export const apiPages = [
       { text: 'Datatype', link: '/api/datatype.html' },
       { text: 'Date', link: '/api/date.html' },
       { text: 'Finance', link: '/api/finance.html' },
+      { text: 'Food', link: '/api/food.html' },
       { text: 'Git', link: '/api/git.html' },
       { text: 'Hacker', link: '/api/hacker.html' },
       { text: 'Helpers', link: '/api/helpers.html' },
@@ -29,7 +30,6 @@ export const apiPages = [
       { text: 'Number', link: '/api/number.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: 'String', link: '/api/string.html' },
       { text: 'System', link: '/api/system.html' },

diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -214,7 +214,11 @@ const config: UserConfig<DefaultTheme.Config> = {
             link: '/guide/randomizer',
           },
           {
-            text: 'Upgrading to v8',
+            text: 'Unique Values',
+            link: '/guide/unique',
+          },
+          {
+            text: 'Upgrading to v9',
             link: '/guide/upgrading',
           },
         ],