Merge branch 'next' into chore-enable-verbatimModuleSyntax

Author: ST-DDT

.github/workflows/ci.yml

@@ -22,7 +22,7 @@ jobs:
     name: 'Build & Unit Test: node-${{ matrix.node_version }}, ${{ matrix.os }}'
     steps:
       - name: Checkout
-        uses: actions/checkout@1d96c772d19495a3b5c517cd2bc0cb401ea0529f # v4.1.3
+        uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
         with:
           # Required for docs/versions tests
           fetch-depth: 0
@@ -70,7 +70,7 @@ jobs:
         run: date
 
       - name: Checkout
-        uses: actions/checkout@1d96c772d19495a3b5c517cd2bc0cb401ea0529f # v4.1.3
+        uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
         with:
           # Required for docs/versions tests
           fetch-depth: 0
@@ -104,7 +104,7 @@ jobs:
     name: 'E2E Doc Test: node-20, ubuntu-latest'
     steps:
       - name: Checkout
-        uses: actions/checkout@1d96c772d19495a3b5c517cd2bc0cb401ea0529f # v4.1.3
+        uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
 
       - name: Install pnpm
         uses: pnpm/action-setup@a3252b78c470c02df07e9d59298aecedc3ccdd6d # v3.0.0
@@ -125,7 +125,7 @@ jobs:
     name: 'Lint: node-20, ubuntu-latest'
     steps:
       - name: Checkout
-        uses: actions/checkout@1d96c772d19495a3b5c517cd2bc0cb401ea0529f # v4.1.3
+        uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
         with:
           fetch-depth: 0
 
@@ -155,7 +155,7 @@ jobs:
     name: 'TS-Check: node-20, ubuntu-latest'
     steps:
       - name: Checkout
-        uses: actions/checkout@1d96c772d19495a3b5c517cd2bc0cb401ea0529f # v4.1.3
+        uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
         with:
           fetch-depth: 0
 
@@ -185,7 +185,7 @@ jobs:
     name: 'Codecov: node-20, ubuntu-latest'
     steps:
       - name: Checkout
-        uses: actions/checkout@1d96c772d19495a3b5c517cd2bc0cb401ea0529f # v4.1.3
+        uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
         with:
           fetch-depth: 0
 

.github/workflows/pr.yml

@@ -15,7 +15,7 @@ jobs:
       pull-requests: write
     steps:
       - name: Checkout
-        uses: actions/checkout@1d96c772d19495a3b5c517cd2bc0cb401ea0529f # v4.1.3
+        uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
         with:
           fetch-depth: 0
 

.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@e9fabac35e210fea40ca5b14c0da95a099eff26f # v5.4.0
+        uses: amannn/action-semantic-pull-request@cfb60706e18bc85e8aec535e3c577abe8f70378e # v5.5.2
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:

docs/.vitepress/config.ts

@@ -4,8 +4,8 @@ import { apiPages } from './api-pages';
 import {
   algoliaIndex,
   currentVersion,
-  oldVersions,
   versionBannerInfix,
+  versionLinks,
 } from './versions';
 
 type SidebarItem = DefaultTheme.SidebarItem;
@@ -14,36 +14,71 @@ const description =
   'Generate massive amounts of fake (but reasonable) data for testing and development.';
 const image = 'https://fakerjs.dev/social-image.png';
 
-function extendSideNav(current: SidebarItem): SidebarItem[] {
+function getSideBarWithExpandedEntry(entryToExpand: string): SidebarItem[] {
   const links: SidebarItem[] = [
     {
       text: 'Guide',
       items: [
         {
-          text: 'Usage Guide',
+          text: 'Getting Started',
           link: '/guide/',
         },
+        {
+          text: 'Usage',
+          link: '/guide/usage',
+        },
+        {
+          text: 'Localization',
+          link: '/guide/localization',
+        },
+        {
+          text: 'Frameworks',
+          link: '/guide/frameworks',
+        },
+        {
+          text: 'Randomizer',
+          link: '/guide/randomizer',
+        },
+        {
+          text: 'Unique Values',
+          link: '/guide/unique',
+        },
+        {
+          text: 'Upgrading to v9',
+          link: '/guide/upgrading',
+        },
       ],
     },
     {
       text: 'API',
-      items: [
-        {
-          text: 'API Reference',
-          link: '/api/',
-        },
-      ],
+      items: apiPages,
     },
     {
       text: 'About',
       items: [
         {
           text: 'Announcements',
           link: '/about/announcements',
+          items: [
+            { text: '2022-09-08', link: '/about/announcements/2022-09-08' },
+            { text: '2022-01-14', link: '/about/announcements/2022-01-14' },
+          ],
         },
         {
           text: 'Roadmap',
           link: '/about/roadmap/',
+          items: [
+            {
+              text: 'v9 - Tree-Shakeable Module-Functions',
+              link: '/about/roadmap/v9',
+            },
+            { text: 'v8 - Make Faker Handier', link: '/about/roadmap/v8' },
+            {
+              text: 'v7 - Cleanup & Improvements',
+              link: '/about/roadmap/v7',
+            },
+            { text: 'v6 - Continue Faker', link: '/about/roadmap/v6' },
+          ],
         },
         {
           text: 'Team',
@@ -56,7 +91,9 @@ function extendSideNav(current: SidebarItem): SidebarItem[] {
       ],
     },
   ];
-  links[links.findIndex((group) => group.text === current.text)] = current;
+  for (const entry of links) {
+    entry.collapsed = entry.text !== entryToExpand;
+  }
   return links;
 }
 
@@ -188,7 +225,7 @@ const config: UserConfig<DefaultTheme.Config> = {
             text: 'Release Notes',
             link: 'https://github.com/faker-js/faker/releases',
           },
-          ...oldVersions.map(({ version, link }) => ({
+          ...versionLinks.map(({ version, link }) => ({
             text: version,
             link,
           })),
@@ -197,81 +234,9 @@ const config: UserConfig<DefaultTheme.Config> = {
     ],
 
     sidebar: {
-      '/guide/': extendSideNav({
-        text: 'Guide',
-        items: [
-          {
-            text: 'Getting Started',
-            link: '/guide/',
-          },
-          {
-            text: 'Usage',
-            link: '/guide/usage',
-          },
-          {
-            text: 'Localization',
-            link: '/guide/localization',
-          },
-          {
-            text: 'Frameworks',
-            link: '/guide/frameworks',
-          },
-          {
-            text: 'Randomizer',
-            link: '/guide/randomizer',
-          },
-          {
-            text: 'Unique Values',
-            link: '/guide/unique',
-          },
-          {
-            text: 'Upgrading to v9',
-            link: '/guide/upgrading',
-          },
-        ],
-      }),
-      '/api/': extendSideNav({
-        text: 'API',
-        items: apiPages,
-      }),
-
-      '/about/': extendSideNav({
-        text: 'About',
-        items: [
-          {
-            text: 'Announcements',
-            link: '/about/announcements',
-            items: [
-              { text: '2022-09-08', link: '/about/announcements/2022-09-08' },
-              { text: '2022-01-14', link: '/about/announcements/2022-01-14' },
-            ],
-          },
-          {
-            text: 'Roadmap',
-            link: '/about/roadmap/',
-            items: [
-              {
-                text: 'v9 - Tree-Shakeable Module-Functions',
-                link: '/about/roadmap/v9',
-              },
-              { text: 'v8 - Make Faker Handier', link: '/about/roadmap/v8' },
-              {
-                text: 'v7 - Cleanup & Improvements',
-                link: '/about/roadmap/v7',
-              },
-              { text: 'v6 - Continue Faker', link: '/about/roadmap/v6' },
-            ],
-          },
-          {
-            text: 'Team',
-            link: '/about/team',
-          },
-          {
-            text: 'Contributing',
-            link: '/about/contributing',
-          },
-        ],
-      }),
+      '/guide/': getSideBarWithExpandedEntry('Guide'),
+      '/api/': getSideBarWithExpandedEntry('API'),
+      '/about/': getSideBarWithExpandedEntry('About'),
     },
   },
 

docs/.vitepress/versions.ts

@@ -9,17 +9,13 @@ function readBranchName(): string {
 }
 
 function readOtherLatestReleaseTagNames(): string[] {
-  const currentMajorVersion = semver.major(version);
   const latestReleaseTagNames = execSync('git tag -l')
     .toString('utf8')
     .split('\n')
     .filter((tag) => semver.valid(tag))
-    .filter((tag) => {
-      // Only consider tags for our deployed website versions,
-      // excluding the current major version.
-      const majorVersion = semver.major(tag);
-      return majorVersion >= 6 && majorVersion !== currentMajorVersion;
-    })
+    // Only consider tags for our deployed website versions
+    .filter((tag) => semver.major(tag) >= 6)
+    // Find the latest tag for each major version
     .reduce<Record<number, string>>((latestTagByMajor, tag) => {
       const majorVersion = semver.major(tag);
 
@@ -39,10 +35,6 @@ const {
   BRANCH: branchName = readBranchName(),
 } = process.env;
 
-const hiddenLink =
-  deployContext === 'production'
-    ? 'https://fakerjs.dev/'
-    : `https://${branchName}.fakerjs.dev/`;
 const otherVersions = readOtherLatestReleaseTagNames();
 const isReleaseBranch = /^v\d+$/.test(branchName);
 
@@ -60,11 +52,7 @@ export const versionBannerInfix: string | null = (() => {
 })();
 
 export const currentVersion = isReleaseBranch ? `v${version}` : branchName;
-export const oldVersions = [
-  {
-    version: 'latest',
-    link: 'https://fakerjs.dev/',
-  },
+export const versionLinks = [
   {
     version: 'next',
     link: 'https://next.fakerjs.dev/',
@@ -73,7 +61,9 @@ export const oldVersions = [
     version,
     link: `https://v${semver.major(version)}.fakerjs.dev/`,
   })),
-].filter(({ link }) => link !== hiddenLink);
+]
+  // Don't link to the current branch's version.
+  .filter(({ link }) => link !== `https://${branchName}.fakerjs.dev/`);
 
 export const algoliaIndex = isReleaseBranch
   ? `fakerjs-v${semver.major(version)}`

docs/api/index.md

@@ -1,7 +1,6 @@
 ---
 layout: page
 title: API Reference
-sidebar: false
 footer: false
 ---
 

netlify.toml

@@ -24,7 +24,7 @@
 
 # Alias for the next page
 [[redirects]]
-  from = "https://v9.fakerjs.dev"
+  from = "https://v10.fakerjs.dev"
   to = "https://next.fakerjs.dev"
   status = 302
   force = true

package.json

@@ -103,8 +103,8 @@
     "@types/validator": "13.11.9",
     "@typescript-eslint/eslint-plugin": "7.7.0",
     "@typescript-eslint/parser": "7.7.0",
-    "@vitest/coverage-v8": "1.5.0",
-    "@vitest/ui": "1.5.0",
+    "@vitest/coverage-v8": "1.5.2",
+    "@vitest/ui": "1.5.2",
     "@vueuse/core": "10.9.0",
     "conventional-changelog-cli": "4.1.0",
     "cypress": "13.8.1",
@@ -131,11 +131,11 @@
     "typescript": "5.4.5",
     "validator": "13.11.0",
     "vite": "5.2.10",
-    "vitepress": "1.1.3",
-    "vitest": "1.5.0",
+    "vitepress": "1.1.4",
+    "vitest": "1.5.2",
     "vue": "3.4.25"
   },
-  "packageManager": "[email protected].5",
+  "packageManager": "[email protected].6",
   "engines": {
     "node": ">=18.0.0",
     "npm": ">=9.0.0"