Merge branch 'next' into image/randomize-defaults

faker-js · Feb 11, 2024 · 00e36ce · 00e36ce
2 parents 1baacce + 50897d9
commit 00e36ce
Show file tree

Hide file tree

Showing 58 changed files with 1,931 additions and 814 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1 +1,2 @@
-* -crlf
+* text eol=lf
+*.png binary
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'
@@ -202,15 +182,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'

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'

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/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' },

diff --git a/docs/guide/upgrading_v9/1953.md b/docs/guide/upgrading_v9/1953.md
@@ -0,0 +1,4 @@
+### Upgrade to TypeScript v5
+
+We now use TypeScript v5 for our project (previously v4).
+While generally not breaking for users, this might have small side effects on our types.
diff --git a/docs/guide/upgrading_v9/2121.md b/docs/guide/upgrading_v9/2121.md
@@ -0,0 +1,3 @@
+### Node 14 and 16 No Longer Supported
+
+Support for Node.js versions 14 and 16 has been discontinued as these versions have reached their [end-of-life](https://github.com/nodejs/Release). Faker.js 9.0 requires a minimum of Node.js version 18.
diff --git a/package.json b/package.json
@@ -95,14 +95,14 @@
     "@eslint-types/typescript-eslint": "~6.19.1",
     "@eslint-types/unicorn": "~50.0.1",
     "@types/markdown-it": "~13.0.7",
-    "@types/node": "~20.11.16",
+    "@types/node": "~20.11.17",
     "@types/sanitize-html": "~2.11.0",
     "@types/semver": "~7.5.6",
-    "@types/validator": "~13.11.8",
+    "@types/validator": "~13.11.9",
     "@typescript-eslint/eslint-plugin": "~6.21.0",
     "@typescript-eslint/parser": "~6.21.0",
-    "@vitest/coverage-v8": "~0.34.6",
-    "@vitest/ui": "~0.34.7",
+    "@vitest/coverage-v8": "~1.2.2",
+    "@vitest/ui": "~1.2.2",
     "@vueuse/core": "~10.7.2",
     "conventional-changelog-cli": "~4.1.0",
     "cypress": "~13.6.4",
@@ -112,10 +112,10 @@
     "eslint-define-config": "~2.1.0",
     "eslint-gitignore": "~0.1.0",
     "eslint-plugin-deprecation": "~2.0.0",
-    "eslint-plugin-jsdoc": "~48.0.5",
+    "eslint-plugin-jsdoc": "~48.0.6",
     "eslint-plugin-prettier": "~5.1.3",
-    "eslint-plugin-unicorn": "~50.0.1",
-    "eslint-plugin-vitest": "~0.3.21",
+    "eslint-plugin-unicorn": "~51.0.1",
+    "eslint-plugin-vitest": "~0.3.22",
     "glob": "~10.3.10",
     "npm-run-all2": "~6.1.2",
     "prettier": "3.2.5",
@@ -124,18 +124,18 @@
     "sanitize-html": "~2.11.0",
     "semver": "~7.6.0",
     "standard-version": "~9.5.0",
-    "tsx": "~3.13.0",
+    "tsx": "~4.7.0",
     "typedoc": "~0.25.7",
-    "typescript": "~4.9.5",
+    "typescript": "~5.3.3",
     "validator": "~13.11.0",
-    "vite": "~4.5.2",
+    "vite": "~5.1.1",
     "vitepress": "1.0.0-rc.39",
-    "vitest": "~0.34.6",
-    "vue": "~3.4.15"
+    "vitest": "~1.2.2",
+    "vue": "~3.4.18"
   },
-  "packageManager": "pnpm@8.5.1",
+  "packageManager": "pnpm@8.15.1",
   "engines": {
-    "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
-    "npm": ">=6.14.13"
+    "node": ">=18.0.0",
+    "npm": ">=9.0.0"
   }
 }
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		### Node 14 and 16 No Longer Supported

		Support for Node.js versions 14 and 16 has been discontinued as these versions have reached their [end-of-life](https://github.com/nodejs/Release). Faker.js 9.0 requires a minimum of Node.js version 18.