Merge branch 'next' into refactor/location/decouple-direction-data-index-from-representation-value

Author: ST-DDT

.eslintrc.js

@@ -2,6 +2,12 @@
 const { defineConfig } = require('eslint-define-config');
 const { readGitignoreFiles } = require('eslint-gitignore');
 
+/// <reference types="@eslint-types/deprecation" />
+/// <reference types="@eslint-types/jsdoc" />
+/// <reference types="@eslint-types/prettier" />
+/// <reference types="@eslint-types/typescript-eslint" />
+/// <reference types="@eslint-types/unicorn" />
+
 module.exports = defineConfig({
   ignorePatterns: [
     ...readGitignoreFiles(),
@@ -15,7 +21,7 @@ module.exports = defineConfig({
   reportUnusedDisableDirectives: true,
   extends: [
     'eslint:recommended',
-    'plugin:@typescript-eslint/recommended-type-checked',
+    'plugin:@typescript-eslint/strict-type-checked',
     'plugin:prettier/recommended',
     'plugin:deprecation/recommended',
     'plugin:jsdoc/recommended-typescript-error',
@@ -29,6 +35,7 @@ module.exports = defineConfig({
     eqeqeq: ['error', 'always', { null: 'ignore' }],
     'no-else-return': 'error',
     'no-restricted-globals': ['error', 'Intl'],
+    'prefer-exponentiation-operator': 'error',
     'prefer-template': 'error',
 
     'unicorn/no-nested-ternary': 'off', // incompatible with prettier
@@ -50,16 +57,11 @@ module.exports = defineConfig({
     'unicorn/consistent-function-scoping': 'off',
     'unicorn/import-style': 'off',
     'unicorn/no-array-callback-reference': 'off',
-    'unicorn/no-array-reduce': 'off',
     'unicorn/no-await-expression-member': 'off',
-    'unicorn/no-negated-condition': 'off',
     'unicorn/no-object-as-default-parameter': 'off',
     'unicorn/no-useless-switch-case': 'off',
     'unicorn/numeric-separators-style': 'off',
-    'unicorn/prefer-code-point': 'off',
     'unicorn/prefer-export-from': 'off',
-    'unicorn/prefer-module': 'off',
-    'unicorn/prefer-negative-index': 'off',
     'unicorn/prefer-string-slice': 'off',
     'unicorn/prevent-abbreviations': 'off',
     'unicorn/require-array-join-separator': 'off',
@@ -91,6 +93,7 @@ module.exports = defineConfig({
       'error',
       { ignoreParameters: true },
     ],
+    '@typescript-eslint/no-unnecessary-condition': 'off', // requires `strictNullChecks` to be enabled
     '@typescript-eslint/no-unsafe-assignment': 'off',
     '@typescript-eslint/no-unsafe-call': 'off',
     '@typescript-eslint/no-unsafe-member-access': 'off',
@@ -103,7 +106,16 @@ module.exports = defineConfig({
       'error',
       { allowNumber: true, allowBoolean: true },
     ],
+    '@typescript-eslint/switch-exhaustiveness-check': [
+      'error',
+      { requireDefaultForNonUnion: true },
+    ],
     '@typescript-eslint/unbound-method': 'off',
+    '@typescript-eslint/unified-signatures': 'off', // incompatible with our api docs generation
+
+    // TODO @ST-DDT 2023-10-10: 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.
+    '@typescript-eslint/no-confusing-void-expression': 'off',
 
     'jsdoc/require-jsdoc': 'off', // Enabled only for src/**/*.ts
     'jsdoc/require-returns': 'off',

.github/workflows/ci.yml

@@ -227,7 +227,7 @@ jobs:
         run: pnpm vitest run --coverage
 
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@eaaf4bedf32dbdc6b720b63067d99c4d77d6047d # v3.1.4
+        uses: codecov/codecov-action@e0b68c6749509c5f83f984dd99a76a1c1a231044 # v4.0.1
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true

.github/workflows/comment-issue.yml

@@ -13,7 +13,7 @@ jobs:
       issues: write
     steps:
       - name: Add Comment For User Interest
-        uses: actions/github-script@d7906e4ad0b1822421a7e6a35d5ca353c962f410 # v6.4.1
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
         with:
           script: |
             github.rest.issues.createComment({
@@ -49,7 +49,7 @@ jobs:
             })
 
       - name: React to Issue
-        uses: actions/github-script@d7906e4ad0b1822421a7e6a35d5ca353c962f410 # v6.4.1
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
         with:
           script: |
             github.rest.reactions.createForIssue({

.github/workflows/pr.yml

@@ -53,7 +53,7 @@ jobs:
         run: pnpm exec tsc .github/workflows/commentCodeGeneration.ts --outDir .github/workflows
 
       - name: Comment
-        uses: actions/github-script@d7906e4ad0b1822421a7e6a35d5ca353c962f410 # v6.4.1
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
         with:
           script: |
             const script = require('${{ github.workspace }}/.github/workflows/commentCodeGeneration.js')

.prettierrc.d.ts

@@ -0,0 +1,4 @@
+import type { Options } from 'prettier';
+
+declare const options: Options;
+export = options;

CHANGELOG.md

@@ -2,6 +2,61 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [8.4.1](https://github.com/faker-js/faker/compare/v8.4.0...v8.4.1) (2024-02-06)
+
+* JSDocs improvements
+
+## [8.4.0](https://github.com/faker-js/faker/compare/v8.3.1...v8.4.0) (2024-01-24)
+
+
+### Features
+
+* **helpers:** add support for complex intermediate types ([#2550](https://github.com/faker-js/faker/issues/2550)) ([24482a3](https://github.com/faker-js/faker/commit/24482a30042eec5b553b30d60985e89fd69a8660))
+* **number:** add parameter `fractionDigits` in float ([#1855](https://github.com/faker-js/faker/issues/1855)) ([41d8778](https://github.com/faker-js/faker/commit/41d87789c7ff353acfd0f5ca88a99c0d1fd3b500))
+* **person:** add job titles for fr ([#2531](https://github.com/faker-js/faker/issues/2531)) ([ba28ab6](https://github.com/faker-js/faker/commit/ba28ab6e59009cceb5b691ddd212e09df22b586e))
+
+
+### Bug Fixes
+
+* **finance:** correct VG IBAN format ([#2552](https://github.com/faker-js/faker/issues/2552)) ([b8049d1](https://github.com/faker-js/faker/commit/b8049d171086bce7b46eb617c88f44cfdd019e00))
+* **internet:** username method to return value that always includes… ([#2506](https://github.com/faker-js/faker/issues/2506)) ([0ee1c67](https://github.com/faker-js/faker/commit/0ee1c6751ec97e10ca1436d2b100b4acb1ac90ec))
+* **locale:** incomplete airline names in zh_CN ([#2558](https://github.com/faker-js/faker/issues/2558)) ([5525b55](https://github.com/faker-js/faker/commit/5525b55cc47fa97b55de52fccff7ab51633e639a))
+* **number:** improve float generation for precisions of form 10^-n ([#2581](https://github.com/faker-js/faker/issues/2581)) ([39c715d](https://github.com/faker-js/faker/commit/39c715d916d69e83795932260f1681df3241db91))
+
+### [8.3.1](https://github.com/faker-js/faker/compare/v8.3.0...v8.3.1) (2023-11-14)
+
+
+### Bug Fixes
+
+* remove `[@internal](https://github.com/internal)` from module parent classes ([#2548](https://github.com/faker-js/faker/issues/2548)) ([77f54ad](https://github.com/faker-js/faker/commit/77f54ad78f9d7952b3b315f72878267f18ed1e69))
+
+## [8.3.0](https://github.com/faker-js/faker/compare/v8.2.0...v8.3.0) (2023-11-14)
+
+
+### Features
+
+* **person:** use fake patterns for jobTitle ([#2528](https://github.com/faker-js/faker/issues/2528)) ([b40ad45](https://github.com/faker-js/faker/commit/b40ad45ad3cca6769968a63264e6d925bf4b328a))
+
+
+### Bug Fixes
+
+* **date:** ensures correct range for birthdate ([#2535](https://github.com/faker-js/faker/issues/2535)) ([7ce8c28](https://github.com/faker-js/faker/commit/7ce8c285cb5b2d13e95a17be78ecbd52f3c7d9db))
+* **finance:** maskedNumber has incorrect defaults ([#2494](https://github.com/faker-js/faker/issues/2494)) ([e0ba50b](https://github.com/faker-js/faker/commit/e0ba50b37e438503ed1899bff35afc92b4f8f49c))
+* **locale:** improve Swedish phone numbers format ([#2520](https://github.com/faker-js/faker/issues/2520)) ([e4865df](https://github.com/faker-js/faker/commit/e4865df199359797397cc3c5455f3a1a9c179f93))
+
+
+### Changed Locales
+
+* **locale:** remove fr_CH data which is identical to fr ([#2526](https://github.com/faker-js/faker/issues/2526)) ([fafcba4](https://github.com/faker-js/faker/commit/fafcba473f8a91eeb8230ebdc1ad5039b25091e1))
+
+
+### New Locales
+
+* **locale:** add person to fr_SN ([#2537](https://github.com/faker-js/faker/issues/2537)) ([ef965da](https://github.com/faker-js/faker/commit/ef965da48a8089e6bb19bcf260bfcd8af1a43799))
+* **locale:** add Senegal locale ([#2525](https://github.com/faker-js/faker/issues/2525)) ([6df70bc](https://github.com/faker-js/faker/commit/6df70bce16500ab74a37f932f2e17a08f297430b))
+* **locale:** add streets to location fr_SN ([#2536](https://github.com/faker-js/faker/issues/2536)) ([36fc517](https://github.com/faker-js/faker/commit/36fc517d17591c8ea1d5135d9a93c7591e3d1f74))
+* **locale:** and location to fr_SN ([#2533](https://github.com/faker-js/faker/issues/2533)) ([f730125](https://github.com/faker-js/faker/commit/f730125ffb941fe936d6a18c775cbe3a99b312dc))
+
 ## [8.2.0](https://github.com/faker-js/faker/compare/v8.1.0...v8.2.0) (2023-10-14)
 
 

LICENSE

@@ -1,4 +1,4 @@
-Faker - Copyright (c) 2022-2023
+Faker - Copyright (c) 2022-2024
 
 This software consists of voluntary contributions made by many individuals.
 For exact contribution history, see the revision history

cypress/e2e/api.cy.ts

@@ -34,7 +34,7 @@ describe('API Test', () => {
       cy.get('.api-group li').each(($el) => {
         const anchor = $el.find('a');
         const text = anchor.text();
-        const link = anchor.attr('href').split('#')[0];
+        const link = anchor.attr('href')?.split('#')[0] ?? 'MISSING';
         if (checked.has(link)) {
           return;
         }

docs/.vitepress/api-pages.ts

@@ -4,32 +4,37 @@ export const apiPages = [
   { text: 'Overview', link: '/api/' },
   { text: 'Faker', link: '/api/faker.html' },
   { text: 'SimpleFaker', link: '/api/simpleFaker.html' },
-  { text: 'Airline', link: '/api/airline.html' },
-  { text: 'Animal', link: '/api/animal.html' },
-  { text: 'Color', link: '/api/color.html' },
-  { text: 'Commerce', link: '/api/commerce.html' },
-  { text: 'Company', link: '/api/company.html' },
-  { text: 'Database', link: '/api/database.html' },
-  { text: 'Datatype', link: '/api/datatype.html' },
-  { text: 'Date', link: '/api/date.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: 'Location', link: '/api/location.html' },
-  { text: 'Lorem', link: '/api/lorem.html' },
-  { text: 'Music', link: '/api/music.html' },
-  { 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' },
-  { text: 'Vehicle', link: '/api/vehicle.html' },
-  { text: 'Word', link: '/api/word.html' },
   { text: 'Randomizer', link: '/api/randomizer.html' },
   { text: 'Utilities', link: '/api/utils.html' },
+  {
+    text: 'Modules',
+    items: [
+      { text: 'Airline', link: '/api/airline.html' },
+      { text: 'Animal', link: '/api/animal.html' },
+      { text: 'Color', link: '/api/color.html' },
+      { text: 'Commerce', link: '/api/commerce.html' },
+      { text: 'Company', link: '/api/company.html' },
+      { text: 'Database', link: '/api/database.html' },
+      { text: 'Datatype', link: '/api/datatype.html' },
+      { text: 'Date', link: '/api/date.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: 'Location', link: '/api/location.html' },
+      { text: 'Lorem', link: '/api/lorem.html' },
+      { text: 'Music', link: '/api/music.html' },
+      { 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' },
+      { text: 'Vehicle', link: '/api/vehicle.html' },
+      { text: 'Word', link: '/api/word.html' },
+    ],
+  },
 ];

docs/.vitepress/config.ts

@@ -1,7 +1,12 @@
-import { defineConfig } from 'vitepress';
-import { DefaultTheme } from 'vitepress/theme';
+import type { UserConfig } from 'vitepress';
+import type { DefaultTheme } from 'vitepress/theme';
 import { apiPages } from './api-pages';
-import { currentVersion, oldVersions, versionBannerInfix } from './versions';
+import {
+  algoliaIndex,
+  currentVersion,
+  oldVersions,
+  versionBannerInfix,
+} from './versions';
 
 type SidebarItem = DefaultTheme.SidebarItem;
 
@@ -55,7 +60,8 @@ function extendSideNav(current: SidebarItem): SidebarItem[] {
   return links;
 }
 
-const config = defineConfig({
+// TODO @Shinigami92 2023-12-28: reuse `defineConfig` from vitepress, when we can go esm-only
+const config: UserConfig<DefaultTheme.Config> = {
   title: 'Faker',
   description,
 
@@ -121,11 +127,14 @@ const config = defineConfig({
       { icon: 'github', link: 'https://github.com/faker-js/faker' },
     ],
 
-    algolia: {
-      apiKey: process.env.API_KEY,
-      appId: process.env.APP_ID,
-      indexName: 'fakerjs',
-    },
+    algolia:
+      process.env.API_KEY == null || process.env.APP_ID == null
+        ? undefined
+        : {
+            apiKey: process.env.API_KEY,
+            appId: process.env.APP_ID,
+            indexName: algoliaIndex,
+          },
 
     footer: {
       message: 'Released under the MIT License.',
@@ -140,7 +149,7 @@ const config = defineConfig({
         link: '/api/',
       },
       {
-        text: 'Ecosystem',
+        text: 'Try it',
         items: [{ text: 'StackBlitz ', link: 'https://fakerjs.dev/new' }],
       },
       {
@@ -256,7 +265,7 @@ const config = defineConfig({
       __BANNER__: versionBannerInfix ?? false,
     },
   },
-});
+};
 
 if (versionBannerInfix) {
   config.head?.push([