Merge branch 'next' into vitest-prefer-each

CHANGELOG.md

@@ -2,6 +2,19 @@
 
 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.0.1](https://github.com/faker-js/faker/compare/v8.0.0...v8.0.1) (2023-05-15)
+
+
+* **docs:** switch doc links to stable ([#2152](https://github.com/faker-js/faker/pull/2152)) ([8f741bd](https://github.com/faker-js/faker/commit/8f741bd4bda455517fd048b83d76bd8e6d89d78e))
+
+## [8.0.0](https://github.com/faker-js/faker/compare/v8.0.0-beta.1...v8.0.0) (2023-05-11)
+
+
+### Bug Fixes
+
+* **docs:** fix faker v7 code example for locale migration ([#2125](https://github.com/faker-js/faker/issues/2125)) ([b570461](https://github.com/faker-js/faker/commit/b57046190754b651842dba14170730f3f7ebd8b5))
+* **locales:** add real cities for zu_ZA and af_ZA, update en_ZA city list ([#2141](https://github.com/faker-js/faker/issues/2141)) ([ee8c97c](https://github.com/faker-js/faker/commit/ee8c97cf6e80025707d5cf458981a14be06406ed))
+
 ## [8.0.0-beta.1](https://github.com/faker-js/faker/compare/v8.0.0-beta.0...v8.0.0-beta.1) (2023-05-06)
 
 

CONTRIBUTING.md

@@ -190,6 +190,39 @@ get cat() {
 }
 ```
 
+## Documenting changes for new major versions
+
+Each major version has an upgrading guide, e.g. [next.fakerjs.dev/guide/upgrading](https://next.fakerjs.dev/guide/upgrading.html).
+
+While developing new features and fixing bugs for a new release, changes are added to the migration guide to aid developers when the version is released.
+
+The general principle is to document anything which requires a normal user of the library to change their code which uses Faker when upgrading to the new major version.
+
+There are two sections:
+
+- Breaking changes (user MUST change their code)
+- Deprecations and other changes (user SHOULD change their code but it will still work for this major version even if they don't)
+
+Not every change needs to be in the migration guide. If it is too long, it becomes hard for users to spot the important changes.
+
+### Should be in the guide
+
+- Breaking changes, e.g. removal of methods
+- Behavior changes, e.g. a different default for a parameter, or a parameter becoming required
+- Whole modules renaming (e.g. faker.name to faker.person)
+- Locale renames
+- Changes to minimum versions e.g. requiring a new version of Node
+- Changes to how Faker is imported
+
+### Doesn't need to be in the guide
+
+- New locales
+- Changes to locale data in existing locales
+- Bugfixes where it's unlikely anyone was relying on the old behavior (eg broken values in locale files)
+- New methods and parameters
+- Straightforward method aliases, e.g. where a method or parameter is renamed but the old name still works identically. (Runtime warnings will already guide the user in this case)
+- Changes to locale definition files which only affect usage via `faker.helpers.fake`, e.g. if a definition file is renamed, but the public API for the method stays the same
+
 ## JSDocs
 
 JSDoc are comments above any code structure (variable, function, class, etc.) that begin with `/**` and end with `*/`. Multiline comments start (if not being the start or end line) with a `*`.

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/ |
-| v7 (stable) | https://fakerjs.dev/      |
-|  v6 (old)   | https://v6.fakerjs.dev/   |
+|   Version    | Website                   |
+| :----------: | :------------------------ |
+| v8.\* (next) | https://next.fakerjs.dev/ |
+| v8 (stable)  | https://fakerjs.dev/      |
+|   v7 (old)   | https://v7.fakerjs.dev/   |
 
 ---
 
@@ -87,7 +87,7 @@ Thus, limiting the import to a single locale can speed up startup times.
 
 ## 💎 Modules
 
-An in-depth overview of the API methods is available in the documentation for [v7 (stable)](https://fakerjs.dev/api/) and [v8 (next)](https://next.fakerjs.dev/api/).
+An in-depth overview of the API methods is available in the documentation for [v8 (stable)](https://fakerjs.dev/api/) and [v8.\* (next)](https://next.fakerjs.dev/api/).
 
 ### Templates
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faker-js/faker",
-  "version": "8.0.0-beta.1",
+  "version": "8.0.1",
   "description": "Generate massive amounts of fake contextual data",
   "keywords": [
     "faker",
@@ -94,32 +94,31 @@
   "devDependencies": {
     "@actions/github": "~5.1.1",
     "@algolia/client-search": "~4.17.0",
-    "@types/glob": "~8.1.0",
     "@types/markdown-it": "~12.2.3",
-    "@types/node": "~18.16.5",
+    "@types/node": "~20.1.2",
     "@types/prettier": "~2.7.2",
     "@types/react": "~18.2.6",
     "@types/sanitize-html": "~2.9.0",
-    "@types/semver": "~7.3.13",
-    "@types/validator": "~13.7.16",
-    "@typescript-eslint/eslint-plugin": "~5.59.2",
-    "@typescript-eslint/parser": "~5.59.2",
+    "@types/semver": "~7.5.0",
+    "@types/validator": "~13.7.17",
+    "@typescript-eslint/eslint-plugin": "~5.59.5",
+    "@typescript-eslint/parser": "~5.59.5",
     "@vitest/coverage-c8": "~0.31.0",
     "@vitest/ui": "~0.31.0",
     "@vueuse/core": "~10.1.2",
     "c8": "~7.13.0",
     "conventional-changelog-cli": "~2.2.2",
-    "cypress": "~12.11.0",
-    "esbuild": "~0.17.18",
+    "cypress": "~12.12.0",
+    "esbuild": "~0.17.19",
     "eslint": "~8.40.0",
     "eslint-config-prettier": "~8.8.0",
     "eslint-define-config": "~1.20.0",
     "eslint-gitignore": "~0.1.0",
     "eslint-plugin-deprecation": "~1.4.1",
-    "eslint-plugin-jsdoc": "~44.0.0",
+    "eslint-plugin-jsdoc": "~44.2.4",
     "eslint-plugin-prettier": "~4.2.1",
     "eslint-plugin-vitest": "~0.2.2",
-    "glob": "~10.2.2",
+    "glob": "~10.2.4",
     "npm-run-all": "~4.1.5",
     "picocolors": "~1.0.0",
     "prettier": "2.8.8",
@@ -128,18 +127,18 @@
     "react-dom": "~18.2.0",
     "rimraf": "~5.0.0",
     "sanitize-html": "~2.10.0",
-    "semver": "~7.5.0",
+    "semver": "~7.5.1",
     "standard-version": "~9.5.0",
     "tsx": "~3.12.7",
     "typedoc": "~0.24.7",
     "typescript": "~4.9.5",
     "validator": "~13.9.0",
-    "vite": "~4.3.5",
+    "vite": "~4.3.6",
     "vitepress": "1.0.0-alpha.75",
     "vitest": "~0.31.0",
-    "vue": "~3.2.47"
+    "vue": "~3.3.2"
   },
-  "packageManager": "pnpm@8.4.0",
+  "packageManager": "pnpm@8.5.1",
   "engines": {
     "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
     "npm": ">=6.14.13"