Merge branch 'next' into fix/finance/maskedNumber-defaults

Author: ST-DDT

.eslintrc.js

@@ -15,7 +15,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',
@@ -59,7 +59,6 @@ module.exports = defineConfig({
     '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 +90,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',
@@ -104,6 +104,11 @@ module.exports = defineConfig({
       { allowNumber: true, allowBoolean: 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',

docs/guide/frameworks.md

@@ -98,3 +98,39 @@ describe('Testing the application', () => {
   });
 });
 ```
+
+## Playwright
+
+Integration with [Playwright](https://playwright.dev/) is also easy:
+
+```ts
+import { faker } from '@faker-js/faker/locale/en';
+import { expect, test } from '@playwright/test';
+
+test.describe('Testing the application', () => {
+  test('should create an account with username and password', async ({
+    page,
+  }) => {
+    const username = faker.internet.userName();
+    const password = faker.internet.password();
+    const email = faker.internet.exampleEmail();
+
+    // Visit the webpage and create an account.
+    await page.goto('https://www.example.com/register');
+    await page.getByLabel('email').fill(email);
+    await page.getByLabel('username').fill(username);
+    await page.getByLabel('password', { exact: true }).fill(password);
+    await page.getByLabel('confirm password').fill(password);
+    await page.getByRole('button', { name: 'Register' }).click();
+
+    // Now, we try to login with these credentials.
+    await page.goto('https://www.example.com/login');
+    await page.getByLabel('email').fill(email);
+    await page.getByLabel('password').fill(password);
+    await page.getByRole('button', { name: 'Login' }).click();
+
+    // We should have logged in successfully to the dashboard page.
+    await expect(page).toHaveURL(/.*dashboard/);
+  });
+});
+```

scripts/apidoc/signature.ts

@@ -342,7 +342,7 @@ function extractDefaultFromComment(comment?: Comment): string | undefined {
     throw new Error(`Found description text after the default value:\n${text}`);
   }
 
-  summary.splice(summary.length - 2, 2);
+  summary.splice(-2, 2);
   const lastSummaryPart = summary[summary.length - 1];
   lastSummaryPart.text = lastSummaryPart.text.replace(/[ \n]Defaults to $/, '');
   return result[2];

src/internal/module-base.ts

@@ -0,0 +1,25 @@
+import type { Faker } from '../faker';
+import type { SimpleFaker } from '../simple-faker';
+import { bindThisToMemberFunctions } from './bind-this-to-member-functions';
+
+/**
+ * Base class for all modules that use a `SimpleFaker` instance.
+ *
+ * @internal
+ */
+export abstract class SimpleModuleBase {
+  constructor(protected readonly faker: SimpleFaker) {
+    bindThisToMemberFunctions(this);
+  }
+}
+
+/**
+ * Base class for all modules that use a `Faker` instance.
+ *
+ * @internal
+ */
+export abstract class ModuleBase extends SimpleModuleBase {
+  constructor(protected readonly faker: Faker) {
+    super(faker);
+  }
+}

src/locales/cs_CZ/person/index.ts

@@ -16,7 +16,6 @@ import male_prefix from './male_prefix';
 import name_ from './name';
 import prefix from './prefix';
 import suffix from './suffix';
-import title from './title';
 
 const person: PersonDefinition = {
   female_first_name,
@@ -32,7 +31,6 @@ const person: PersonDefinition = {
   name: name_,
   prefix,
   suffix,
-  title,
 };
 
 export default person;

src/locales/cs_CZ/person/title.ts

@@ -12,7 +12,6 @@ import male_first_name from './male_first_name';
 import male_prefix from './male_prefix';
 import name_ from './name';
 import prefix from './prefix';
-import title from './title';
 
 const person: PersonDefinition = {
   female_first_name,
@@ -24,7 +23,6 @@ const person: PersonDefinition = {
   male_prefix,
   name: name_,
   prefix,
-  title,
 };
 
 export default person;

src/locales/he/person/index.ts

@@ -14,7 +14,6 @@ import male_prefix from './male_prefix';
 import name_ from './name';
 import prefix from './prefix';
 import sex from './sex';
-import title from './title';
 
 const person: PersonDefinition = {
   female_first_name,
@@ -28,7 +27,6 @@ const person: PersonDefinition = {
   name: name_,
   prefix,
   sex,
-  title,
 };
 
 export default person;