From 66227ace28e4cea3a6cb6fad067b2a8a3813ec73 Mon Sep 17 00:00:00 2001 From: Piotr Kuczynski Date: Tue, 5 Aug 2025 12:27:08 +0200 Subject: [PATCH 1/6] docs: split custom Faker instance example --- src/faker.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/faker.ts b/src/faker.ts index cac89a32bda..1b0ee09a35d 100644 --- a/src/faker.ts +++ b/src/faker.ts @@ -43,11 +43,13 @@ import { mergeLocales } from './utils/merge-locales'; * * faker.person.firstName(); // 'John' * faker.person.lastName(); // 'Doe' + * + * Create Faker instance with only `es` data and no `en` fallback (=> smaller bundle size): + * * @example * import { Faker, es } from '@faker-js/faker'; * // const { Faker, es } = require('@faker-js/faker'); * - * // create a Faker instance with only es data and no en fallback (=> smaller bundle size) * const customFaker = new Faker({ locale: [es] }); * * customFaker.person.firstName(); // 'Javier' From b46fc5eeb6b392feb2eb8fe8a74e0ff83fff822f Mon Sep 17 00:00:00 2001 From: Piotr Kuczynski Date: Tue, 5 Aug 2025 12:58:38 +0200 Subject: [PATCH 2/6] next try --- src/faker.ts | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/faker.ts b/src/faker.ts index 1b0ee09a35d..b5ee27297c7 100644 --- a/src/faker.ts +++ b/src/faker.ts @@ -44,9 +44,11 @@ import { mergeLocales } from './utils/merge-locales'; * faker.person.firstName(); // 'John' * faker.person.lastName(); // 'Doe' * - * Create Faker instance with only `es` data and no `en` fallback (=> smaller bundle size): - * * @example + * // + * // Create Faker instance with only `es` data and no `en` fallback (=> smaller bundle size): + * // + * * import { Faker, es } from '@faker-js/faker'; * // const { Faker, es } = require('@faker-js/faker'); * From 104926e7eb22d2f99aa099bc97ad1a280466d366 Mon Sep 17 00:00:00 2001 From: Piotr Kuczynski Date: Tue, 5 Aug 2025 13:11:37 +0200 Subject: [PATCH 3/6] try again --- src/faker.ts | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/faker.ts b/src/faker.ts index b5ee27297c7..d66f924bb6e 100644 --- a/src/faker.ts +++ b/src/faker.ts @@ -43,12 +43,11 @@ import { mergeLocales } from './utils/merge-locales'; * * faker.person.firstName(); // 'John' * faker.person.lastName(); // 'Doe' - * * @example + * * // * // Create Faker instance with only `es` data and no `en` fallback (=> smaller bundle size): * // - * * import { Faker, es } from '@faker-js/faker'; * // const { Faker, es } = require('@faker-js/faker'); * From 2b1382d89fe4963995ec763511aa30bd1c8848a2 Mon Sep 17 00:00:00 2001 From: Piotr Kuczynski Date: Tue, 5 Aug 2025 13:17:16 +0200 Subject: [PATCH 4/6] try again with extra line --- src/faker.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/src/faker.ts b/src/faker.ts index d66f924bb6e..0090f77487c 100644 --- a/src/faker.ts +++ b/src/faker.ts @@ -45,6 +45,7 @@ import { mergeLocales } from './utils/merge-locales'; * faker.person.lastName(); // 'Doe' * @example * + * * // * // Create Faker instance with only `es` data and no `en` fallback (=> smaller bundle size): * // From 093035e7559959d704135729e5389788a82ee67d Mon Sep 17 00:00:00 2001 From: Piotr Kuczynski Date: Tue, 5 Aug 2025 13:19:06 +0200 Subject: [PATCH 5/6] revert extra line --- src/faker.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/src/faker.ts b/src/faker.ts index 0090f77487c..d66f924bb6e 100644 --- a/src/faker.ts +++ b/src/faker.ts @@ -45,7 +45,6 @@ import { mergeLocales } from './utils/merge-locales'; * faker.person.lastName(); // 'Doe' * @example * - * * // * // Create Faker instance with only `es` data and no `en` fallback (=> smaller bundle size): * // From 9352293f227e78a8e9e75a566839e15f593a6913 Mon Sep 17 00:00:00 2001 From: Piotr Kuczynski Date: Tue, 5 Aug 2025 13:21:15 +0200 Subject: [PATCH 6/6] try without second @example tag --- src/faker.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/src/faker.ts b/src/faker.ts index d66f924bb6e..05956ae99bf 100644 --- a/src/faker.ts +++ b/src/faker.ts @@ -43,7 +43,6 @@ import { mergeLocales } from './utils/merge-locales'; * * faker.person.firstName(); // 'John' * faker.person.lastName(); // 'Doe' - * @example * * // * // Create Faker instance with only `es` data and no `en` fallback (=> smaller bundle size):