Merge branch 'next' into chore/better-british-addresses

Author: ST-DDT

.github/workflows/pr.yml

@@ -35,11 +35,13 @@ jobs:
           CYPRESS_INSTALL_BINARY: 0
 
       - name: Generate code
+        id: generate
         run: |
           pnpm run generate:locales
           pnpm run generate:api-docs
           pnpm run build
           pnpm run test -u
+        continue-on-error: true
 
       - name: Check diff
         id: diff
@@ -56,8 +58,8 @@ jobs:
         with:
           script: |
             const script = require('${{ github.workspace }}/.github/workflows/commentCodeGeneration.js')
-            await script(github, context, ${{ steps.diff.outcome == 'success' }})
+            await script(github, context, ${{ steps.generate.outcome == 'success' && steps.diff.outcome == 'success' }})
 
       - name: Status
-        if: ${{ steps.diff.outcome == 'failure' }}
+        if: ${{ steps.generate.outcome == 'failure' || steps.diff.outcome == 'failure' }}
         run: exit 1

docs/.vitepress/config.ts

@@ -193,6 +193,10 @@ const config = defineConfig({
             text: 'Localization',
             link: '/guide/localization',
           },
+          {
+            text: 'Frameworks',
+            link: '/guide/frameworks',
+          },
           {
             text: 'Upgrading to v8',
             link: '/guide/upgrading',

docs/guide/frameworks.md

@@ -0,0 +1,100 @@
+# Frameworks
+
+Faker can easily be used with a variety of testing frameworks. Here are a few examples with popular frameworks.
+
+Note that these examples use only the `en` locale for better performance. For more information visit [localization](./localization.md).
+
+## Vitest and Jest
+
+Since [Vitest](https://vitest.dev/) and [Jest](https://jestjs.io/) use an extremely similar notation, this section will cover both at once.
+The main difference is that testing methods need to be imported in Vitest.
+Simply crop that line out for a Jest integration.
+
+These frameworks work about exactly as you would expect with Faker. Here's a minimal example:
+
+```ts
+import { describe, it, expect } from 'vitest';
+import { faker } from '@faker-js/faker/locale/en';
+
+describe('reverse array', () => {
+  it('should reverse the array', () => {
+    const title = faker.name.jobTitle();
+    const name = faker.name.fullName();
+    const animal = faker.animal.bear();
+
+    const array = [title, name, animal];
+
+    expect(array.reverse()).toStrictEqual([animal, name, title]);
+  });
+});
+```
+
+It can sometimes be useful to do seeded tests, where we seed our faker instance with a static value so that it will generate the same random value each time.
+These are especially useful in tests that are meant to be deterministic, such as snapshot tests.
+
+- [Snapshots in Vitest](https://vitest.dev/guide/snapshot.html)
+- [Snapshots in Jest](https://jestjs.io/docs/snapshot-testing)
+
+```ts
+import { describe, it, expect } from 'vitest';
+import { faker } from '@faker-js/faker/locale/en';
+
+// We might want other tests to *not* be seeded. This will re-seed our faker instance after each test.
+afterEach(() => {
+  faker.seed();
+});
+
+describe('reverse array', () => {
+  it('should reverse the array', () => {
+    // Seed our faker instance with some static number.
+    faker.seed(1234);
+    const title = faker.name.jobTitle();
+    const name = faker.name.fullName();
+    const animal = faker.animal.bear();
+
+    const array = [title, name, animal];
+
+    expect(array.reverse()).toStrictEqual([animal, name, title]);
+
+    // Expect our value to always match a generated snapshot.
+    expect(array.reverse()).toMatchSnapshot();
+  });
+});
+```
+
+## Cypress
+
+[Cypress](https://www.cypress.io/) integration is fairly straighforward as well:
+
+```ts
+import { faker } from '@faker-js/faker/locale/en';
+
+describe('Testing the application', () => {
+  it('should create an account with username and password', () => {
+    let username = faker.internet.userName();
+    let password = faker.internet.password();
+    let email = faker.internet.exampleEmail();
+
+    // Visit the a webpage and create an account.
+    cy.visit('https://www.example.com/register');
+
+    cy.get('#email-input').type(email);
+    cy.get('#username-input').type(username);
+    cy.get('#password-input').type(password);
+    cy.get('#password-confirm-input').type(password);
+
+    cy.get('#register-submit-input').click();
+
+    // Now, we try to login with these credentials.
+    cy.visit('https://www.example.com/login');
+
+    cy.get('#email-input').type(email);
+    cy.get('#password-input').type(password);
+
+    cy.get('#login-submit-input').click();
+
+    // We should have logged in successfully to the dashboard page.
+    cy.url().should('include', '/dashboard');
+  });
+});
+```

docs/guide/upgrading.md

@@ -34,6 +34,7 @@ Not the version you are looking for?
 | `faker.address.citySuffix`      | _Removed_                                                         |
 | `faker.address.streetPrefix`    | _Removed_                                                         |
 | `faker.address.streetSuffix`    | _Removed_                                                         |
+| `faker.image.lorempixel`        | _Removed, as the LoremPixel service is no longer available_       |
 
 ### Locale renamed
 

package.json

@@ -97,21 +97,21 @@
     "@algolia/client-search": "~4.14.2",
     "@types/glob": "~8.0.0",
     "@types/markdown-it": "~12.2.3",
-    "@types/node": "~18.11.10",
+    "@types/node": "~18.11.13",
     "@types/prettier": "~2.7.1",
     "@types/react": "~18.0.26",
     "@types/sanitize-html": "~2.6.2",
     "@types/semver": "~7.3.13",
     "@types/validator": "~13.7.10",
-    "@typescript-eslint/eslint-plugin": "~5.45.0",
-    "@typescript-eslint/parser": "~5.45.0",
-    "@vitest/coverage-c8": "~0.25.3",
-    "@vitest/ui": "~0.25.3",
+    "@typescript-eslint/eslint-plugin": "~5.46.0",
+    "@typescript-eslint/parser": "~5.46.0",
+    "@vitest/coverage-c8": "~0.25.7",
+    "@vitest/ui": "~0.25.7",
     "@vueuse/core": "~9.6.0",
     "c8": "~7.12.0",
     "conventional-changelog-cli": "~2.2.2",
-    "cypress": "~11.2.0",
-    "esbuild": "~0.15.18",
+    "cypress": "~12.0.2",
+    "esbuild": "~0.16.4",
     "eslint": "~8.29.0",
     "eslint-config-prettier": "~8.5.0",
     "eslint-define-config": "~1.12.0",
@@ -123,7 +123,7 @@
     "mime-db": "~1.52.0",
     "npm-run-all": "~4.1.5",
     "picocolors": "~1.0.0",
-    "prettier": "2.8.0",
+    "prettier": "2.8.1",
     "prettier-plugin-organize-imports": "~3.2.1",
     "react": "~18.2.0",
     "react-dom": "~18.2.0",
@@ -133,16 +133,16 @@
     "simple-git-hooks": "~2.8.1",
     "standard-version": "~9.5.0",
     "tsx": "~3.12.1",
-    "typedoc": "~0.23.21",
+    "typedoc": "~0.23.22",
     "typedoc-plugin-missing-exports": "~1.0.0",
-    "typescript": "~4.9.3",
+    "typescript": "~4.9.4",
     "validator": "~13.7.0",
-    "vite": "~3.2.5",
-    "vitepress": "1.0.0-alpha.30",
-    "vitest": "~0.25.3",
+    "vite": "~4.0.0",
+    "vitepress": "1.0.0-alpha.31",
+    "vitest": "~0.25.7",
     "vue": "~3.2.45"
   },
-  "packageManager": "[email protected].0",
+  "packageManager": "[email protected].1",
   "engines": {
     "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
     "npm": ">=6.14.13"