Merge branch 'main' into fix/mersenne-rand-invalid-input-argument

Author: Shinigami92

.eslintrc.js

@@ -28,6 +28,7 @@ module.exports = defineConfig({
   rules: {
     // We may want to use this in the future
     'no-useless-escape': 'off',
+    eqeqeq: ['error', 'always', { null: 'ignore' }],
 
     '@typescript-eslint/ban-ts-comment': 'warn',
     '@typescript-eslint/consistent-type-imports': 'error',

.github/renovate.json5

@@ -5,31 +5,51 @@
   "reviewersFromCodeOwners": true,
   "rangeStrategy": "bump",
   "packageRules": [
+    {
+      "groupName": "devDependencies",
+      "matchDepTypes": ["devDependencies"],
+      "rangeStrategy": "bump"
+    },
+    {
+      "groupName": "dependencies",
+      "matchDepTypes": ["dependencies"],
+      "rangeStrategy": "replace"
+    },
+    {
+      "groupName": "peerDependencies",
+      "matchDepTypes": ["peerDependencies"],
+      "rangeStrategy": "widen"
+    },
+    {
+      "groupName": "engines",
+      "matchDepTypes": ["engines"],
+      "rangeStrategy": "replace"
+    },
     {
       "groupName": "typescript-eslint",
       "matchPackagePrefixes": ["@typescript-eslint/"]
     },
+    {
+      "groupName": "vitest",
+      "matchPackageNames": ["@vitest/ui", "vitest"]
+    },
+    {
+      "groupName": "prettier",
+      "matchPackageNames": ["@types/prettier", "prettier"]
+    },
+    {
+      "groupName": "typescript",
+      "matchPackageNames": ["typescript"]
+    },
     {
       "groupName": "doc-dependencies",
-      "matchPackagePrefixes": [
+      "matchPackageNames": [
         "typedoc",
         "typedoc-plugin-missing-exports",
         "vitepress"
       ]
-    },
-    {
-      "groupName": "vitest",
-      "matchPackagePrefixes": ["@vitest/ui", "vitest"]
     }
   ],
-  "ignoreDeps": [
-    // manually bumping
-    "@types/node",
-    "node",
-    "npm",
-    "prettier",
-    "typescript"
-  ],
   "vulnerabilityAlerts": {
     "labels": ["security"],
     "assignees": ["team:maintainers"]

.github/workflows/ci.yml

@@ -23,15 +23,15 @@ jobs:
     name: 'Build & Unit Test: node-${{ matrix.node_version }}, ${{ matrix.os }}'
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Install pnpm
         uses: pnpm/action-setup@v2
         with:
           version: 6
 
       - name: Set node version to ${{ matrix.node_version }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node_version }}
           cache: 'pnpm'
@@ -52,7 +52,7 @@ jobs:
     name: 'E2E Doc Test: node-16, ubuntu-latest'
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Install pnpm
         uses: pnpm/action-setup@v2
@@ -70,7 +70,7 @@ jobs:
     name: 'Lint: node-16, ubuntu-latest'
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
 
@@ -80,7 +80,7 @@ jobs:
           version: 6
 
       - name: Set node version to 16
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: 16
           cache: 'pnpm'
@@ -101,7 +101,7 @@ jobs:
     name: 'Codecov: node-16, ubuntu-latest'
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
 
@@ -111,7 +111,7 @@ jobs:
           version: 6
 
       - name: Set node version to 16
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: 16
           cache: 'pnpm'

.github/workflows/issue-labeling.yml

@@ -11,7 +11,7 @@ jobs:
       - name: contribution welcome
         # If the issue is labeled with 'help wanted', a comment will be posted
         if: github.event.label.name == 'help wanted'
-        uses: actions-cool/issues-helper@v2
+        uses: actions-cool/issues-helper@v3
         with:
           actions: 'welcome, remove-labels'
           token: ${{ secrets.GITHUB_TOKEN }}
@@ -24,7 +24,7 @@ jobs:
         # If the issue is given either the 'enhancement' or 'bug' label, the 'pending triage' label will be removed
         # Issues without the label 'pending triage' are filtered with the third part of the condition, since the label does not have to be removed
         if: github.event.label.name == 'enhancement' || github.event.label.name == 'bug' || (contains(github.event.label.name, 'pending triage') == false)
-        uses: actions-cool/issues-helper@v2
+        uses: actions-cool/issues-helper@v3
         with:
           actions: 'remove-labels'
           token: ${{ secrets.GITHUB_TOKEN }}

.prettierrc.cjs

@@ -4,9 +4,7 @@
  * @type {import('prettier').Options}
  */
 module.exports = {
-  plugins: [
-    /* require.resolve("prettier-plugin-organize-imports") */
-  ],
+  plugins: [require.resolve('prettier-plugin-organize-imports')],
   singleQuote: true,
   overrides: [
     {

CHANGELOG.md

@@ -2,6 +2,26 @@
 
 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.
 
+## [6.0.0-beta.0](https://github.com/faker-js/faker/compare/v6.0.0-alpha.6...v6.0.0-beta.0) (2022-03-07)
+
+
+### Features
+
+* **types:** generate all locales index files with non-any types ([#494](https://github.com/faker-js/faker/issues/494)) ([b611ca1](https://github.com/faker-js/faker/commit/b611ca1c6f7d756f224a1a7b641e36b531d169be))
+* **types:** provide strong typing for locales 2 ([#398](https://github.com/faker-js/faker/issues/398)) ([419e9e2](https://github.com/faker-js/faker/commit/419e9e20a570b44909faf24c9019bf7f232ee7a9))
+
+
+### Bug Fixes
+
+* correcting the readme file ([#529](https://github.com/faker-js/faker/issues/529)) ([6c9dcdd](https://github.com/faker-js/faker/commit/6c9dcdd03050ef70554fc2bb6ccc0c883fd1edc9))
+* fix bicycle_types files being named incorrectly ([#477](https://github.com/faker-js/faker/issues/477)) ([7a2a522](https://github.com/faker-js/faker/commit/7a2a522c181dc696f6e9b4767ca18d39bad4476d))
+* fix time.recent method signature ([#586](https://github.com/faker-js/faker/issues/586)) ([60d3cc5](https://github.com/faker-js/faker/commit/60d3cc519cd2cab061a23fbe09164d8b59e177ff))
+* fix unique method types ([#457](https://github.com/faker-js/faker/issues/457)) ([14df7d3](https://github.com/faker-js/faker/commit/14df7d3f70b54c4a153f5dcf111ef90575bbbe9e))
+* handle missing or broken locales main index files ([#478](https://github.com/faker-js/faker/issues/478)) ([ff97431](https://github.com/faker-js/faker/commit/ff974319a63acbcbbb96cf1a67a48616de9fd9da))
+* move el credit card information to the expected location ([#484](https://github.com/faker-js/faker/issues/484)) ([dcbd18e](https://github.com/faker-js/faker/commit/dcbd18e13ab53e837de17cec7b3f8e51ba479d0e))
+* remove invalid aliases ([#488](https://github.com/faker-js/faker/issues/488)) ([58fbfe3](https://github.com/faker-js/faker/commit/58fbfe3835b0f27949e7eb262d246eb9d84bb870))
+* test random.alphaNumeric ([#517](https://github.com/faker-js/faker/issues/517)) ([41ec6f0](https://github.com/faker-js/faker/commit/41ec6f08784afc2a674568328a0ea2bfb033a411))
+
 ## [6.0.0-alpha.7](https://github.com/faker-js/faker/compare/v6.0.0-alpha.6...v6.0.0-alpha.7) (2022-02-20)
 
 

README.md

@@ -59,7 +59,7 @@ const randomEmail = faker.internet.email(); // [email protected]
 const randomCard = faker.helpers.createCard(); // random contact card containing many properties
 ```
 
-### Deno
+### CDN/Deno
 
 ```js
 import { faker } from 'https://cdn.skypack.dev/@faker-js/faker';

docs/.vitepress/config.mjs

@@ -96,6 +96,7 @@ export default defineConfig({
     editLinkText: 'Suggest changes to this page',
     nav,
     sidebar,
-    algolia,
+    // TODO 2022-03-06: https://github.com/faker-js/faker/issues/222
+    // algolia,
   },
 });

docs/.vitepress/theme/components/index.mjs

@@ -1,5 +1,5 @@
-import Playground from './Playground.vue';
 import Badge from './Badge.vue';
+import Playground from './Playground.vue';
 
 export default {
   Playground,

docs/.vitepress/theme/index.mjs

@@ -1,6 +1,6 @@
-import './index.css';
-import GlobalComponents from './components';
 import DefaultTheme from 'vitepress/theme';
+import GlobalComponents from './components';
+import './index.css';
 
 export default {
   ...DefaultTheme,

docs/api/.gitignore

@@ -1,4 +1,3 @@
 *.md
-!fake.md
 !localization.md
 *.ts

docs/api/fake.md

@@ -36,33 +36,49 @@ Faker now ships with its own types! Remove `@types/faker` from your `package.jso
 
 ### Tree-shaking
 
-Faker now supports tree-shaking! We highly recommend that you take advantage of your bundler's tree-shaking capabilities and change how you import Faker. This is especially true if you're importing Faker in the browser.
+:::warning
+Tree shaking is not yet fully supported due to some structural issues. But we plan to make Faker fully tree-shakable in the future.
+:::
 
-Faker is a giant package made up of many megabytes of strings. Only import what you need.
+For now Faker supports tree-shaking for some parts, and we highly recommend that you take advantage of your bundler's tree-shaking capabilities and change how you import Faker right now.
 
-:::tip
-Migrating to the new tree-shakeable syntax should be quick and painless.
-:::
+Instead of using:
 
-For JS:
+```ts
+// js
+const faker = require('@faker-js/faker');
 
-```js
+// ts
+import faker from '@faker-js/faker';
+```
+
+You should switch to:
+
+```ts
+// js
 const { faker } = require('@faker-js/faker');
 
-// Or specific locale
-const fakerDe = require('@faker-js/faker/locale/de');
+// ts
+import { faker } from '@faker-js/faker';
 ```
 
-For TS:
+If you only need one specific language, we highly recommend to make use of the locale specific imports like:
 
 ```ts
-import { faker } from '@faker-js/faker';
+// js
+const fakerDe = require('@faker-js/faker/locale/de');
 
-// Or specific locale
+// ts
 import fakerDe from '@faker-js/faker/locale/de';
 ```
 
-Please [open an issue on GitHub](https://github.com/faker-js/faker/issues/new?assignees=&labels=pending+triage&template=freestyle.md) if we've missed any steps.
+This is especially true if you're importing Faker in the browser.
+
+Faker is a giant package made up of many megabytes of strings. Only import what you need.
+
+_We plan to load the locales in another way in a future major release._
+
+---
 
 Happy Faking!
 

docs/migration-guide-v5/index.md

@@ -46,6 +46,7 @@ We have eight maintainers currently.
 - griest - [GitLab](https://gitlab.com/griest)
 - Mateus Dadalto - [GitHub](https://github.com/MateusDadalto), [Twitter](https://twitter.com/MateusD)
 - Jessica Sachs - [GitHub](https://github.com/JessicaSachs), [Twitter](https://twitter.com/_JessicaSachs)
+- Daniel Theuke - [GitHub](https://github.com/ST-DDT)
 
 ## What has the team done so far?
 

docs/update.md

@@ -1,6 +1,6 @@
 {
   "name": "@faker-js/faker",
-  "version": "6.0.0-alpha.7",
+  "version": "6.0.0-beta.0",
   "description": "Generate massive amounts of fake contextual data",
   "keywords": [
     "faker",
@@ -90,41 +90,42 @@
   },
   "devDependencies": {
     "@types/markdown-it": "~12.2.3",
-    "@types/node": "~16.11.25",
+    "@types/node": "~16.11.26",
     "@types/prettier": "~2.4.4",
     "@types/sanitize-html": "~2.6.2",
     "@types/validator": "~13.7.1",
-    "@typescript-eslint/eslint-plugin": "~5.12.1",
-    "@typescript-eslint/parser": "~5.12.1",
-    "@vitest/ui": "~0.5.1",
+    "@typescript-eslint/eslint-plugin": "~5.14.0",
+    "@typescript-eslint/parser": "~5.14.0",
+    "@vitest/ui": "~0.6.0",
     "c8": "~7.11.0",
     "conventional-changelog-cli": "~2.2.2",
-    "cypress": "~9.5.0",
-    "esbuild": "~0.14.23",
-    "eslint": "~8.9.0",
-    "eslint-config-prettier": "~8.4.0",
+    "cypress": "~9.5.1",
+    "esbuild": "~0.14.25",
+    "eslint": "~8.10.0",
+    "eslint-config-prettier": "~8.5.0",
     "eslint-define-config": "~1.2.5",
     "eslint-gitignore": "~0.1.0",
-    "eslint-plugin-jsdoc": "~37.9.4",
+    "eslint-plugin-jsdoc": "~37.9.7",
     "eslint-plugin-prettier": "~4.0.0",
     "esno": "~0.14.1",
-    "lint-staged": "~12.3.4",
+    "lint-staged": "~12.3.5",
     "npm-run-all": "~4.1.5",
     "picocolors": "~1.0.0",
     "prettier": "2.5.1",
+    "prettier-plugin-organize-imports": "~2.3.4",
     "rimraf": "~3.0.2",
     "sanitize-html": "~2.7.0",
     "simple-git-hooks": "~2.7.0",
     "standard-version": "~9.3.2",
-    "typedoc": "~0.22.12",
+    "typedoc": "~0.22.13",
     "typedoc-plugin-missing-exports": "~0.22.6",
-    "typescript": "~4.5.5",
+    "typescript": "~4.6.2",
     "validator": "~13.7.0",
-    "vite": "~2.8.4",
-    "vitepress": "~0.22.2",
-    "vitest": "~0.5.1"
+    "vite": "~2.8.6",
+    "vitepress": "~0.22.3",
+    "vitest": "~0.6.0"
   },
-  "packageManager": "pnpm@6.31.0",
+  "packageManager": "pnpm@6.32.3",
   "engines": {
     "node": ">=14.0.0",
     "npm": ">=7.0.0"