From 0198cb086e0121c4472187910c65ae4dbe5ffd1f Mon Sep 17 00:00:00 2001 From: Hanna Kuczynska Date: Tue, 19 Jul 2022 13:27:31 +0200 Subject: [PATCH 01/21] feat: extract sex generator from name.gender to name.sex --- src/definitions/name.ts | 2 +- src/locales/en/name/binary_gender.ts | 1 - src/locales/en/name/index.ts | 4 +-- src/locales/en/name/sex.ts | 1 + src/locales/fr/name/index.ts | 4 +-- .../fr/name/{binary_gender.ts => sex.ts} | 0 src/locales/fr_CH/name/index.ts | 4 +-- .../fr_CH/name/{binary_gender.ts => sex.ts} | 0 src/locales/pt_BR/name/index.ts | 4 +-- .../pt_BR/name/{binary_gender.ts => sex.ts} | 0 src/locales/ur/name/index.ts | 4 +-- .../ur/name/{binary_gender.ts => sex.ts} | 0 src/modules/name/index.ts | 25 ++++++++++++++----- 13 files changed, 31 insertions(+), 18 deletions(-) delete mode 100644 src/locales/en/name/binary_gender.ts create mode 100644 src/locales/en/name/sex.ts rename src/locales/fr/name/{binary_gender.ts => sex.ts} (100%) rename src/locales/fr_CH/name/{binary_gender.ts => sex.ts} (100%) rename src/locales/pt_BR/name/{binary_gender.ts => sex.ts} (100%) rename src/locales/ur/name/{binary_gender.ts => sex.ts} (100%) diff --git a/src/definitions/name.ts b/src/definitions/name.ts index 9098a66a1f7..c1da15681a8 100644 --- a/src/definitions/name.ts +++ b/src/definitions/name.ts @@ -5,7 +5,7 @@ import type { LocaleEntry } from './definitions'; */ export type NameDefinitions = LocaleEntry<{ gender: string[]; - binary_gender: string[]; + sex: string[]; prefix?: string[]; female_prefix?: string[]; diff --git a/src/locales/en/name/binary_gender.ts b/src/locales/en/name/binary_gender.ts deleted file mode 100644 index 347a852f493..00000000000 --- a/src/locales/en/name/binary_gender.ts +++ /dev/null @@ -1 +0,0 @@ -export default ['Female', 'Male']; diff --git a/src/locales/en/name/index.ts b/src/locales/en/name/index.ts index 67668f73061..c1522a38996 100644 --- a/src/locales/en/name/index.ts +++ b/src/locales/en/name/index.ts @@ -3,7 +3,6 @@ * Run 'pnpm run generate:locales' to update. */ import type { NameDefinitions } from '../../..'; -import binary_gender from './binary_gender'; import female_first_name from './female_first_name'; import female_middle_name from './female_middle_name'; import first_name from './first_name'; @@ -14,11 +13,11 @@ import male_middle_name from './male_middle_name'; import middle_name from './middle_name'; import name_ from './name'; import prefix from './prefix'; +import sex from './sex'; import suffix from './suffix'; import title from './title'; const name: NameDefinitions = { - binary_gender, female_first_name, female_middle_name, first_name, @@ -29,6 +28,7 @@ const name: NameDefinitions = { middle_name, name: name_, prefix, + sex, suffix, title, }; diff --git a/src/locales/en/name/sex.ts b/src/locales/en/name/sex.ts new file mode 100644 index 00000000000..52185d0bd9e --- /dev/null +++ b/src/locales/en/name/sex.ts @@ -0,0 +1 @@ +export default ['female', 'male', 'non-binary']; diff --git a/src/locales/fr/name/index.ts b/src/locales/fr/name/index.ts index 64963579864..fb0bbc37f27 100644 --- a/src/locales/fr/name/index.ts +++ b/src/locales/fr/name/index.ts @@ -3,23 +3,23 @@ * Run 'pnpm run generate:locales' to update. */ import type { NameDefinitions } from '../../..'; -import binary_gender from './binary_gender'; import female_first_name from './female_first_name'; import first_name from './first_name'; import last_name from './last_name'; import male_first_name from './male_first_name'; import name_ from './name'; import prefix from './prefix'; +import sex from './sex'; import title from './title'; const name: NameDefinitions = { - binary_gender, female_first_name, first_name, last_name, male_first_name, name: name_, prefix, + sex, title, }; diff --git a/src/locales/fr/name/binary_gender.ts b/src/locales/fr/name/sex.ts similarity index 100% rename from src/locales/fr/name/binary_gender.ts rename to src/locales/fr/name/sex.ts diff --git a/src/locales/fr_CH/name/index.ts b/src/locales/fr_CH/name/index.ts index 64963579864..fb0bbc37f27 100644 --- a/src/locales/fr_CH/name/index.ts +++ b/src/locales/fr_CH/name/index.ts @@ -3,23 +3,23 @@ * Run 'pnpm run generate:locales' to update. */ import type { NameDefinitions } from '../../..'; -import binary_gender from './binary_gender'; import female_first_name from './female_first_name'; import first_name from './first_name'; import last_name from './last_name'; import male_first_name from './male_first_name'; import name_ from './name'; import prefix from './prefix'; +import sex from './sex'; import title from './title'; const name: NameDefinitions = { - binary_gender, female_first_name, first_name, last_name, male_first_name, name: name_, prefix, + sex, title, }; diff --git a/src/locales/fr_CH/name/binary_gender.ts b/src/locales/fr_CH/name/sex.ts similarity index 100% rename from src/locales/fr_CH/name/binary_gender.ts rename to src/locales/fr_CH/name/sex.ts diff --git a/src/locales/pt_BR/name/index.ts b/src/locales/pt_BR/name/index.ts index d4c0e73a1df..2565f4d5669 100644 --- a/src/locales/pt_BR/name/index.ts +++ b/src/locales/pt_BR/name/index.ts @@ -3,24 +3,24 @@ * Run 'pnpm run generate:locales' to update. */ import type { NameDefinitions } from '../../..'; -import binary_gender from './binary_gender'; import female_first_name from './female_first_name'; import first_name from './first_name'; import last_name from './last_name'; import male_first_name from './male_first_name'; import name_ from './name'; import prefix from './prefix'; +import sex from './sex'; import suffix from './suffix'; import title from './title'; const name: NameDefinitions = { - binary_gender, female_first_name, first_name, last_name, male_first_name, name: name_, prefix, + sex, suffix, title, }; diff --git a/src/locales/pt_BR/name/binary_gender.ts b/src/locales/pt_BR/name/sex.ts similarity index 100% rename from src/locales/pt_BR/name/binary_gender.ts rename to src/locales/pt_BR/name/sex.ts diff --git a/src/locales/ur/name/index.ts b/src/locales/ur/name/index.ts index d4c0e73a1df..2565f4d5669 100644 --- a/src/locales/ur/name/index.ts +++ b/src/locales/ur/name/index.ts @@ -3,24 +3,24 @@ * Run 'pnpm run generate:locales' to update. */ import type { NameDefinitions } from '../../..'; -import binary_gender from './binary_gender'; import female_first_name from './female_first_name'; import first_name from './first_name'; import last_name from './last_name'; import male_first_name from './male_first_name'; import name_ from './name'; import prefix from './prefix'; +import sex from './sex'; import suffix from './suffix'; import title from './title'; const name: NameDefinitions = { - binary_gender, female_first_name, first_name, last_name, male_first_name, name: name_, prefix, + sex, suffix, title, }; diff --git a/src/locales/ur/name/binary_gender.ts b/src/locales/ur/name/sex.ts similarity index 100% rename from src/locales/ur/name/binary_gender.ts rename to src/locales/ur/name/sex.ts diff --git a/src/modules/name/index.ts b/src/modules/name/index.ts index 009b35fc45f..0ce31639df4 100644 --- a/src/modules/name/index.ts +++ b/src/modules/name/index.ts @@ -1,4 +1,5 @@ import type { Faker } from '../..'; +import { deprecated } from '../../internal/deprecated'; export enum Gender { female = 'female', @@ -180,22 +181,34 @@ export class Name { /** * Return a random gender. * - * @param binary Whether to return only binary gender names. Defaults to `false`. - * * @example * faker.name.gender() // 'Trans*Man' - * faker.name.gender(true) // 'Female' */ gender(binary?: boolean): string { if (binary) { - return this.faker.helpers.arrayElement( - this.faker.definitions.name.binary_gender - ); + deprecated({ + deprecated: 'faker.name.gender(true)', + proposed: 'faker.name.sex()', + since: '7.4', + until: '8.0', + }); + + return this.faker.name.sex(); } return this.faker.helpers.arrayElement(this.faker.definitions.name.gender); } + /** + * Return a random sex. + * + * @example + * faker.name.sex() // 'female' + */ + sex(): string { + return this.faker.helpers.arrayElement(this.faker.definitions.name.sex); + } + /** * Returns a random name prefix. * From 398ff3e033d340604dde868485b465e6f17efa04 Mon Sep 17 00:00:00 2001 From: Hanna Kuczynska Date: Tue, 19 Jul 2022 13:36:55 +0200 Subject: [PATCH 02/21] test: add tests --- test/__snapshots__/name.spec.ts.snap | 6 ++++++ test/name.spec.ts | 17 ++++++++++++++++- 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/test/__snapshots__/name.spec.ts.snap b/test/__snapshots__/name.spec.ts.snap index e07b604707c..3557800b46c 100644 --- a/test/__snapshots__/name.spec.ts.snap +++ b/test/__snapshots__/name.spec.ts.snap @@ -20,6 +20,8 @@ exports[`name > seed: 42 > middleName() 1`] = `"Greer"`; exports[`name > seed: 42 > prefix() 1`] = `"Mrs."`; +exports[`name > seed: 42 > sex() 1`] = `"male"`; + exports[`name > seed: 42 > suffix() 1`] = `"III"`; exports[`name > seed: 1211 > findName() 1`] = `"Claude Trantow"`; @@ -42,6 +44,8 @@ exports[`name > seed: 1211 > middleName() 1`] = `"Sawyer"`; exports[`name > seed: 1211 > prefix() 1`] = `"Dr."`; +exports[`name > seed: 1211 > sex() 1`] = `"non-binary"`; + exports[`name > seed: 1211 > suffix() 1`] = `"DVM"`; exports[`name > seed: 1337 > findName() 1`] = `"Leona Cronin"`; @@ -64,4 +68,6 @@ exports[`name > seed: 1337 > middleName() 1`] = `"Dakota"`; exports[`name > seed: 1337 > prefix() 1`] = `"Mrs."`; +exports[`name > seed: 1337 > sex() 1`] = `"female"`; + exports[`name > seed: 1337 > suffix() 1`] = `"I"`; diff --git a/test/name.spec.ts b/test/name.spec.ts index 1d9f44219b2..71e18281ecd 100644 --- a/test/name.spec.ts +++ b/test/name.spec.ts @@ -11,6 +11,7 @@ const functionNames = [ 'findName', 'jobTitle', 'gender', + 'sex', 'prefix', 'suffix', 'jobDescriptor', @@ -243,7 +244,21 @@ describe('name', () => { const gender = faker.name.gender(true); expect(gender).toBeTypeOf('string'); - expect(faker.definitions.name.binary_gender).toContain(gender); + expect(faker.definitions.name.sex).toContain(gender); + }); + }); + + describe('sex()', () => { + beforeEach(() => { + faker.locale = 'en'; + faker.localeFallback = 'en'; + }); + + it('should return a sex', () => { + const sex = faker.name.sex(); + + expect(sex).toBeTypeOf('string'); + expect(faker.definitions.name.sex).toContain(sex); }); }); From 5fe76642c76335e93fb89a3cd84dd2b353cc1a8f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Leyla=20J=C3=A4hnig?= Date: Tue, 19 Jul 2022 09:55:24 +0200 Subject: [PATCH 03/21] chore(linting): disable `unbound-method` warnings (#1128) --- .eslintrc.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.eslintrc.js b/.eslintrc.js index 70b2861faa4..afc6a3bae5a 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -50,7 +50,7 @@ module.exports = defineConfig({ allowBoolean: true, }, ], - '@typescript-eslint/unbound-method': 'warn', + '@typescript-eslint/unbound-method': 'off', }, overrides: [ { From 8b41348ff563b79f20e634a2a5d347b3e85f59b2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Leyla=20J=C3=A4hnig?= Date: Tue, 19 Jul 2022 10:07:28 +0200 Subject: [PATCH 04/21] refactor(name.findName): rename to fullName (#1127) --- src/modules/name/index.ts | 44 ++++++++++- test/__snapshots__/name.spec.ts.snap | 6 ++ test/name.spec.ts | 112 +++++++++++++++++++++++++-- 3 files changed, 150 insertions(+), 12 deletions(-) diff --git a/src/modules/name/index.ts b/src/modules/name/index.ts index 0ce31639df4..79dd0c921d1 100644 --- a/src/modules/name/index.ts +++ b/src/modules/name/index.ts @@ -141,19 +141,55 @@ export class Name { * @param gender The optional gender to use. * Can be either `'female'` or `'male'`. * + * @see faker.name.fullName() + * * @example * faker.name.findName() // 'Allen Brown' * faker.name.findName('Joann') // 'Joann Osinski' * faker.name.findName('Marcella', '', 'female') // 'Mrs. Marcella Huels' * faker.name.findName(undefined, 'Beer') // 'Mr. Alfonso Beer' * faker.name.findName(undefined, undefined, 'male') // 'Fernando Schaefer' + * + * @deprecated Use faker.name.fullName() instead. */ findName(firstName?: string, lastName?: string, gender?: GenderType): string { - const normalizedGender: GenderType = - gender ?? this.faker.helpers.arrayElement(['female', 'male']); + deprecated({ + deprecated: 'faker.name.findName()', + proposed: 'faker.name.fullName()', + since: '7.4', + until: '8.0', + }); + return this.fullName({ firstName, lastName, gender }); + } - firstName = firstName || this.firstName(normalizedGender); - lastName = lastName || this.lastName(normalizedGender); + /** + * Generates a random full name. + * + * @param options An options object. Defaults to `{}`. + * @param options.firstName The optional first name to use. If not specified a random one will be chosen. + * @param options.lastName The optional last name to use. If not specified a random one will be chosen. + * @param options.gender The optional gender to use. + * Can be either `'female'` or `'male'`. + * + * @example + * faker.name.fullName() // 'Allen Brown' + * faker.name.fullName('Joann') // 'Joann Osinski' + * faker.name.fullName('Marcella', '', 'female') // 'Mrs. Marcella Huels' + * faker.name.fullName(undefined, 'Beer') // 'Mr. Alfonso Beer' + * faker.name.fullName(undefined, undefined, 'male') // 'Fernando Schaefer' + */ + fullName( + options: { + firstName?: string; + lastName?: string; + gender?: GenderType; + } = {} + ): string { + const { + gender = this.faker.helpers.arrayElement(['female', 'male']), + firstName = this.firstName(gender), + lastName = this.lastName(gender), + } = options; const nameParts: string[] = []; const prefix = this.faker.helpers.maybe(() => this.prefix(gender), { diff --git a/test/__snapshots__/name.spec.ts.snap b/test/__snapshots__/name.spec.ts.snap index 3557800b46c..bb2026694f9 100644 --- a/test/__snapshots__/name.spec.ts.snap +++ b/test/__snapshots__/name.spec.ts.snap @@ -4,6 +4,8 @@ exports[`name > seed: 42 > findName() 1`] = `"Sadie Wiegand"`; exports[`name > seed: 42 > firstName() 1`] = `"Garnett"`; +exports[`name > seed: 42 > fullName() 1`] = `"Sadie Wiegand"`; + exports[`name > seed: 42 > gender() 1`] = `"Gender nonconforming"`; exports[`name > seed: 42 > jobArea() 1`] = `"Identity"`; @@ -28,6 +30,8 @@ exports[`name > seed: 1211 > findName() 1`] = `"Claude Trantow"`; exports[`name > seed: 1211 > firstName() 1`] = `"Tito"`; +exports[`name > seed: 1211 > fullName() 1`] = `"Claude Trantow"`; + exports[`name > seed: 1211 > gender() 1`] = `"Trigender"`; exports[`name > seed: 1211 > jobArea() 1`] = `"Factors"`; @@ -52,6 +56,8 @@ exports[`name > seed: 1337 > findName() 1`] = `"Leona Cronin"`; exports[`name > seed: 1337 > firstName() 1`] = `"Devyn"`; +exports[`name > seed: 1337 > fullName() 1`] = `"Leona Cronin"`; + exports[`name > seed: 1337 > gender() 1`] = `"Demigender"`; exports[`name > seed: 1337 > jobArea() 1`] = `"Functionality"`; diff --git a/test/name.spec.ts b/test/name.spec.ts index 71e18281ecd..921d82aa381 100644 --- a/test/name.spec.ts +++ b/test/name.spec.ts @@ -1,22 +1,24 @@ import { afterEach, beforeEach, describe, expect, it } from 'vitest'; import { faker } from '../src'; +import type { Name } from '../src/modules/name'; import { seededRuns } from './support/seededRuns'; const NON_SEEDED_BASED_RUN = 5; -const functionNames = [ +const functionNames: (keyof Name)[] = [ + 'findName', 'firstName', + 'fullName', + 'gender', + 'jobArea', + 'jobDescriptor', + 'jobTitle', + 'jobType', 'lastName', 'middleName', - 'findName', - 'jobTitle', - 'gender', - 'sex', 'prefix', + 'sex', 'suffix', - 'jobDescriptor', - 'jobArea', - 'jobType', ]; describe('name', () => { @@ -227,6 +229,100 @@ describe('name', () => { }); }); + describe('fullName()', () => { + beforeEach(() => { + faker.locale = 'en'; + faker.localeFallback = 'en'; + }); + + it('should return a name with firstName and lastName', () => { + const fullName = faker.name.fullName(); + + expect(fullName).toBeTypeOf('string'); + expect(fullName).toContain(' '); + }); + + it('should return a female gender-specific name without firstName and lastName', () => { + faker.locale = 'mk'; + + const female_specific = [ + ...faker.definitions.name.female_prefix, + ...faker.definitions.name.female_first_name, + ...faker.definitions.name.female_last_name, + ...faker.definitions.name.suffix, + ]; + + const fullName = faker.name.fullName({ gender: 'female' }); + + const parts = fullName.split(' '); + for (const part of parts) { + expect(female_specific).toContain(part); + } + }); + + it('should return a male gender-specific name without firstName and lastName', () => { + faker.locale = 'mk'; + + const male_specific = [ + ...faker.definitions.name.male_prefix, + ...faker.definitions.name.male_first_name, + ...faker.definitions.name.male_last_name, + ...faker.definitions.name.suffix, + ]; + + const fullName = faker.name.fullName({ gender: 'male' }); + + const parts = fullName.split(' '); + for (const part of parts) { + expect(male_specific).toContain(part); + } + }); + + it('should return a female gender-specific name with given firstName and lastName', () => { + faker.locale = 'mk'; + + const male_specific = [ + ...faker.definitions.name.female_prefix, + 'firstName', + 'lastName', + ...faker.definitions.name.suffix, + ]; + + const fullName = faker.name.fullName({ + firstName: 'firstName', + lastName: 'lastName', + gender: 'female', + }); + + const parts = fullName.split(' '); + for (const part of parts) { + expect(male_specific).toContain(part); + } + }); + + it('should return a male gender-specific name with given firstName and lastName', () => { + faker.locale = 'mk'; + + const male_specific = [ + ...faker.definitions.name.male_prefix, + 'firstName', + 'lastName', + ...faker.definitions.name.suffix, + ]; + + const fullName = faker.name.fullName({ + firstName: 'firstName', + lastName: 'lastName', + gender: 'male', + }); + + const parts = fullName.split(' '); + for (const part of parts) { + expect(male_specific).toContain(part); + } + }); + }); + describe('gender()', () => { beforeEach(() => { faker.locale = 'en'; From a748bbcacde62f64b05852262a1f983c7f90421c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Leyla=20J=C3=A4hnig?= Date: Tue, 19 Jul 2022 11:46:07 +0200 Subject: [PATCH 05/21] feat(system.fileName): file extension count (#1101) Co-authored-by: Piotr Kuczynski --- src/modules/system/index.ts | 32 +++++++++++++++++++++++---- test/system.spec.ts | 44 +++++++++++++++++++++++++++++++++++++ 2 files changed, 72 insertions(+), 4 deletions(-) diff --git a/src/modules/system/index.ts b/src/modules/system/index.ts index 200deafe49c..77be5a8267c 100644 --- a/src/modules/system/index.ts +++ b/src/modules/system/index.ts @@ -31,13 +31,37 @@ export class System { /** * Returns a random file name with extension. * + * @param options An options object. + * @param options.extensionCount Define how many extensions the file name should have. A negative number will be treated as `0`. Defaults to `1`. + * * @example * faker.system.fileName() // 'self_enabling_accountability_toys.kpt' + * faker.system.fileName({ extensionCount: 2 }) // 'bike_table.res.vcs' */ - fileName(): string { - const str = this.faker.random.words().toLowerCase().replace(/\W/g, '_'); + fileName( + options: { + /** + * Define how many extensions the file name should have. A negative number will be treated as `0`. Defaults to `1`. + */ + extensionCount?: number; + } = {} + ): string { + const { extensionCount = 1 } = options; + + const baseName = this.faker.random + .words() + .toLowerCase() + .replace(/\W/g, '_'); + + if (extensionCount <= 0) { + return baseName; + } + + const extensionsStr = Array.from({ length: extensionCount }) + .map(() => this.fileExt()) + .join('.'); - return `${str}.${this.fileExt()}`; + return `${baseName}.${extensionsStr}`; } /** @@ -49,7 +73,7 @@ export class System { * faker.system.commonFileName('txt') // 'global_borders_wyoming.txt' */ commonFileName(ext?: string): string { - const str = this.faker.random.words().toLowerCase().replace(/\W/g, '_'); + const str = this.fileName({ extensionCount: 0 }); return `${str}.${ext || this.commonFileExt()}`; } diff --git a/test/system.spec.ts b/test/system.spec.ts index 559d7bed7c2..f795abfbaaa 100644 --- a/test/system.spec.ts +++ b/test/system.spec.ts @@ -2,6 +2,7 @@ import validator from 'validator'; import { afterEach, describe, expect, it } from 'vitest'; import { faker } from '../src'; import { seededRuns } from './support/seededRuns'; +import { times } from './support/times'; const NON_SEEDED_BASED_RUN = 5; @@ -48,15 +49,23 @@ describe('system', () => { 'gif', 'htm', 'html', + 'jpe', 'jpeg', + 'jpg', + 'm1v', 'm2a', 'm2v', + 'm3a', 'mp2', + 'mp2a', 'mp3', 'mp4', 'mp4v', + 'mpe', 'mpeg', 'mpg', + 'mpg4', + 'mpga', 'pdf', 'png', 'shtml', @@ -180,6 +189,41 @@ describe('system', () => { 'generated fileNames should have an extension' ).toContain('.'); }); + + it('should return filenames with 1 ext per default', () => { + const fileName = faker.system.fileName(); + const parts = fileName.split('.'); + + expect(parts).length(2); + }); + + it('should return filenames without an extension when extensionCount is 0', () => { + const fileName = faker.system.fileName({ + extensionCount: 0, + }); + + expect(fileName).not.toContain('.'); + }); + + it('should return filenames without an extension when extensionCount is negative', () => { + const fileName = faker.system.fileName({ + extensionCount: -1, + }); + + expect(fileName).not.toContain('.'); + }); + + it.each(times(10))( + 'should return filenames with %s extensions', + (extensionCount) => { + const fileName = faker.system.fileName({ + extensionCount, + }); + const parts = fileName.split('.'); + + expect(parts).length(extensionCount + 1); + } + ); }); describe('filePath()', () => { From 7d360d7eb3af045c03086e75d6455c2d743ce148 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Tue, 19 Jul 2022 13:50:09 +0200 Subject: [PATCH 06/21] chore(deps): update doc-dependencies (#1160) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- package.json | 4 ++-- pnpm-lock.yaml | 59 ++++++++++++++++++++++++++++++++++++++++---------- 2 files changed, 49 insertions(+), 14 deletions(-) diff --git a/package.json b/package.json index 6e1d04062c7..265a7d1a71d 100644 --- a/package.json +++ b/package.json @@ -93,7 +93,7 @@ ] }, "devDependencies": { - "@algolia/client-search": "~4.13.1", + "@algolia/client-search": "~4.14.0", "@types/markdown-it": "~12.2.3", "@types/node": "~18.0.6", "@types/prettier": "~2.6.3", @@ -127,7 +127,7 @@ "simple-git-hooks": "~2.8.0", "standard-version": "~9.5.0", "tsx": "~3.8.0", - "typedoc": "~0.23.7", + "typedoc": "~0.23.8", "typedoc-plugin-missing-exports": "~0.23.0", "typescript": "~4.7.4", "validator": "~13.7.0", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index df68600fe21..b91741b93bc 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -1,7 +1,7 @@ lockfileVersion: 5.4 specifiers: - '@algolia/client-search': ~4.13.1 + '@algolia/client-search': ~4.14.0 '@types/markdown-it': ~12.2.3 '@types/node': ~18.0.6 '@types/prettier': ~2.6.3 @@ -35,7 +35,7 @@ specifiers: simple-git-hooks: ~2.8.0 standard-version: ~9.5.0 tsx: ~3.8.0 - typedoc: ~0.23.7 + typedoc: ~0.23.8 typedoc-plugin-missing-exports: ~0.23.0 typescript: ~4.7.4 validator: ~13.7.0 @@ -44,7 +44,7 @@ specifiers: vitest: ~0.18.1 devDependencies: - '@algolia/client-search': 4.13.1 + '@algolia/client-search': 4.14.0 '@types/markdown-it': 12.2.3 '@types/node': 18.0.6 '@types/prettier': 2.6.3 @@ -83,7 +83,7 @@ devDependencies: typescript: 4.7.4 validator: 13.7.0 vite: 3.0.1 - vitepress: 0.22.4_tbq7qqbbedk3tko5ldgdax3r7a + vitepress: 0.22.4_tgqivcw5eyibsasgiakey2gfxq vitest: 0.18.1_bwiefpfzp76ffdlldte4lgx5gy packages: @@ -94,14 +94,14 @@ packages: '@algolia/autocomplete-shared': 1.7.1 dev: true - /@algolia/autocomplete-preset-algolia/1.7.1_jr4xm7x4v4vd7iifhnoo3rb33u: + /@algolia/autocomplete-preset-algolia/1.7.1_fab3r74sakexbqciq34evjvaqi: resolution: {integrity: sha512-pJwmIxeJCymU1M6cGujnaIYcY3QPOVYZOXhFkWVM7IxKzy272BwCvMFMyc5NpG/QmiObBxjo7myd060OeTNJXg==} peerDependencies: '@algolia/client-search': ^4.9.1 algoliasearch: ^4.9.1 dependencies: '@algolia/autocomplete-shared': 1.7.1 - '@algolia/client-search': 4.13.1 + '@algolia/client-search': 4.14.0 algoliasearch: 4.13.1 dev: true @@ -119,6 +119,10 @@ packages: resolution: {integrity: sha512-7Vaf6IM4L0Jkl3sYXbwK+2beQOgVJ0mKFbz/4qSxKd1iy2Sp77uTAazcX+Dlexekg1fqGUOSO7HS4Sx47ZJmjA==} dev: true + /@algolia/cache-common/4.14.0: + resolution: {integrity: sha512-9bCWX78td6DEtyVIJc2R8MokniFFgbS5r9ADVvBuBeDtVuNhOwDO/MYZ2WlAQJTwos9TtS9v0iJ9Ym0rDHMldA==} + dev: true + /@algolia/cache-in-memory/4.13.1: resolution: {integrity: sha512-pZzybCDGApfA/nutsFK1P0Sbsq6fYJU3DwIvyKg4pURerlJM4qZbB9bfLRef0FkzfQu7W11E4cVLCIOWmyZeuQ==} dependencies: @@ -149,6 +153,13 @@ packages: '@algolia/transporter': 4.13.1 dev: true + /@algolia/client-common/4.14.0: + resolution: {integrity: sha512-7pmtPOicY6QEBQEYinChkVVi0SnDGcgJn1P0GkWxIMD23ZQk7o0/eMAQYqkGR3TET6YB/bZDeDrpL5v4DKN3tg==} + dependencies: + '@algolia/requester-common': 4.14.0 + '@algolia/transporter': 4.14.0 + dev: true + /@algolia/client-personalization/4.13.1: resolution: {integrity: sha512-1CqrOW1ypVrB4Lssh02hP//YxluoIYXAQCpg03L+/RiXJlCs+uIqlzC0ctpQPmxSlTK6h07kr50JQoYH/TIM9w==} dependencies: @@ -165,10 +176,22 @@ packages: '@algolia/transporter': 4.13.1 dev: true + /@algolia/client-search/4.14.0: + resolution: {integrity: sha512-gFxteVMUzEMq6lDEex/gZKNudrFmOFLuWS9SQCU+sXeTCRw32aY5/RBDigOkD6Yp6nLkfnYWvPnDshwY6WgTbw==} + dependencies: + '@algolia/client-common': 4.14.0 + '@algolia/requester-common': 4.14.0 + '@algolia/transporter': 4.14.0 + dev: true + /@algolia/logger-common/4.13.1: resolution: {integrity: sha512-L6slbL/OyZaAXNtS/1A8SAbOJeEXD5JcZeDCPYDqSTYScfHu+2ePRTDMgUTY4gQ7HsYZ39N1LujOd8WBTmM2Aw==} dev: true + /@algolia/logger-common/4.14.0: + resolution: {integrity: sha512-1Fw+5Nd4d7NWNA9FhOIIXzESJn+j5VTO/f3YK+XhoOlbAwfMbD32InWEjNglrcHnSO8kpqrizFXveKTx1CzoKw==} + dev: true + /@algolia/logger-console/4.13.1: resolution: {integrity: sha512-7jQOTftfeeLlnb3YqF8bNgA2GZht7rdKkJ31OCeSH2/61haO0tWPoNRjZq9XLlgMQZH276pPo0NdiArcYPHjCA==} dependencies: @@ -185,6 +208,10 @@ packages: resolution: {integrity: sha512-eGVf0ID84apfFEuXsaoSgIxbU3oFsIbz4XiotU3VS8qGCJAaLVUC5BUJEkiFENZIhon7hIB4d0RI13HY4RSA+w==} dev: true + /@algolia/requester-common/4.14.0: + resolution: {integrity: sha512-8DGIW5keIbAFet2TKGr/C9DVJ1r8IWFjgf4URPHn6NHMf6R+ruQp0gOf7xBP1Bw6JIS3/DbvlGqbw8sNO/N+Hw==} + dev: true + /@algolia/requester-node-http/4.13.1: resolution: {integrity: sha512-7C0skwtLdCz5heKTVe/vjvrqgL/eJxmiEjHqXdtypcE5GCQCYI15cb+wC4ytYioZDMiuDGeVYmCYImPoEgUGPw==} dependencies: @@ -199,6 +226,14 @@ packages: '@algolia/requester-common': 4.13.1 dev: true + /@algolia/transporter/4.14.0: + resolution: {integrity: sha512-AP+8Qxeg0XvQ3rFbj4pIUzDMmtjo5pgBMx/57ADbge5Y4Y9ByDdQNjEKk6QFIe70SAwR/cGzglwYg7nl8mK/OA==} + dependencies: + '@algolia/cache-common': 4.14.0 + '@algolia/logger-common': 4.14.0 + '@algolia/requester-common': 4.14.0 + dev: true + /@babel/code-frame/7.18.6: resolution: {integrity: sha512-TDCmlK5eOvH+eH7cdAFlNXeVJqWIQ7gW9tY1GJIpUtFb6CmjVyq2VM3u71bOyR8CRihcCgMUYoDNyLXao3+70Q==} engines: {node: '>=6.9.0'} @@ -284,10 +319,10 @@ packages: resolution: {integrity: sha512-utLgg7E1agqQeqCJn05DWC7XXMk4tMUUnL7MZupcknRu2OzGN13qwey2qA/0NAKkVBGugiWtON0+rlU0QIPojg==} dev: true - /@docsearch/js/3.1.1_tbq7qqbbedk3tko5ldgdax3r7a: + /@docsearch/js/3.1.1_tgqivcw5eyibsasgiakey2gfxq: resolution: {integrity: sha512-bt7l2aKRoSnLUuX+s4LVQ1a7AF2c9myiZNv5uvQCePG5tpvVGpwrnMwqVXOUJn9q6FwVVhOrQMO/t+QmnnAEUw==} dependencies: - '@docsearch/react': 3.1.1_tbq7qqbbedk3tko5ldgdax3r7a + '@docsearch/react': 3.1.1_tgqivcw5eyibsasgiakey2gfxq preact: 10.10.0 transitivePeerDependencies: - '@algolia/client-search' @@ -296,7 +331,7 @@ packages: - react-dom dev: true - /@docsearch/react/3.1.1_tbq7qqbbedk3tko5ldgdax3r7a: + /@docsearch/react/3.1.1_tgqivcw5eyibsasgiakey2gfxq: resolution: {integrity: sha512-cfoql4qvtsVRqBMYxhlGNpvyy/KlCoPqjIsJSZYqYf9AplZncKjLBTcwBu6RXFMVCe30cIFljniI4OjqAU67pQ==} peerDependencies: '@types/react': '>= 16.8.0 < 19.0.0' @@ -304,7 +339,7 @@ packages: react-dom: '>= 16.8.0 < 19.0.0' dependencies: '@algolia/autocomplete-core': 1.7.1 - '@algolia/autocomplete-preset-algolia': 1.7.1_jr4xm7x4v4vd7iifhnoo3rb33u + '@algolia/autocomplete-preset-algolia': 1.7.1_fab3r74sakexbqciq34evjvaqi '@docsearch/css': 3.1.1 '@types/react': 18.0.15 algoliasearch: 4.13.1 @@ -4556,13 +4591,13 @@ packages: fsevents: 2.3.2 dev: true - /vitepress/0.22.4_tbq7qqbbedk3tko5ldgdax3r7a: + /vitepress/0.22.4_tgqivcw5eyibsasgiakey2gfxq: resolution: {integrity: sha512-oZUnLO/SpYdThaBKefDeOiVlr0Rie4Ppx3FzMnMyLtJnI5GlBMNjqYqMy/4+umm/iC+ZDJfI+IlDKxv5fZnYzA==} engines: {node: '>=14.0.0'} hasBin: true dependencies: '@docsearch/css': 3.1.1 - '@docsearch/js': 3.1.1_tbq7qqbbedk3tko5ldgdax3r7a + '@docsearch/js': 3.1.1_tgqivcw5eyibsasgiakey2gfxq '@vitejs/plugin-vue': 2.3.3_vite@2.9.14+vue@3.2.37 prismjs: 1.28.0 vite: 2.9.14 From b4aba276d9fda1788df1eab3272d0b43e68d8379 Mon Sep 17 00:00:00 2001 From: Hanna Kuczynska Date: Wed, 20 Jul 2022 12:00:24 +0200 Subject: [PATCH 07/21] fix: restore params in doc --- src/modules/name/index.ts | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/modules/name/index.ts b/src/modules/name/index.ts index f1548ae1236..dd325dcfc77 100644 --- a/src/modules/name/index.ts +++ b/src/modules/name/index.ts @@ -217,8 +217,11 @@ export class Name { /** * Return a random gender. * + * @param binary Whether to return only binary gender names. Defaults to `false`. + * * @example * faker.name.gender() // 'Trans*Man' + * faker.name.gender(true) // 'Female' */ gender(binary?: boolean): string { if (binary) { From 6b6c9b5a8a1f1ef8874a200953bf45d60a94a73c Mon Sep 17 00:00:00 2001 From: Hanna Kuczynska Date: Wed, 20 Jul 2022 12:02:11 +0200 Subject: [PATCH 08/21] docs: deprecate param --- src/modules/name/index.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/modules/name/index.ts b/src/modules/name/index.ts index dd325dcfc77..2fb9cc328ec 100644 --- a/src/modules/name/index.ts +++ b/src/modules/name/index.ts @@ -217,7 +217,7 @@ export class Name { /** * Return a random gender. * - * @param binary Whether to return only binary gender names. Defaults to `false`. + * @param binary (deprecated) Whether to return only binary gender names. Defaults to `false`. * * @example * faker.name.gender() // 'Trans*Man' From b2f97a67ba1da57eac82550c48b4b03889ac9bcd Mon Sep 17 00:00:00 2001 From: Hanna Kuczynska Date: Tue, 26 Jul 2022 19:52:57 +0200 Subject: [PATCH 09/21] fix: tests --- src/modules/name/index.ts | 1 - test/__snapshots__/name.spec.ts.snap | 18 +++++++++++++++--- .../apidoc/examplesAndDeprecations.spec.ts | 2 +- 3 files changed, 16 insertions(+), 5 deletions(-) diff --git a/src/modules/name/index.ts b/src/modules/name/index.ts index 9922431d981..7ad07584766 100644 --- a/src/modules/name/index.ts +++ b/src/modules/name/index.ts @@ -224,7 +224,6 @@ export class Name { * * @example * faker.name.gender() // 'Trans*Man' - * faker.name.gender(true) // 'Female' */ gender(binary?: boolean): string { if (binary) { diff --git a/test/__snapshots__/name.spec.ts.snap b/test/__snapshots__/name.spec.ts.snap index dc56d58ea46..6acb01b1f1c 100644 --- a/test/__snapshots__/name.spec.ts.snap +++ b/test/__snapshots__/name.spec.ts.snap @@ -24,7 +24,7 @@ exports[`name > 42 > fullName > with lastName 1`] = `"Sadie Doe"`; exports[`name > 42 > gender > noArgs 1`] = `"Gender nonconforming"`; -exports[`name > 42 > gender > with gender 1`] = `"Female"`; +exports[`name > 42 > gender > with gender 1`] = `"male"`; exports[`name > 42 > jobArea 1`] = `"Identity"`; @@ -46,6 +46,10 @@ exports[`name > 42 > prefix > noArgs 1`] = `"Mrs."`; exports[`name > 42 > prefix > with gender 1`] = `"Mrs."`; +exports[`name > 42 > sex > noArgs 1`] = `"male"`; + +exports[`name > 42 > sex > with gender 1`] = `"male"`; + exports[`name > 42 > suffix > noArgs 1`] = `"III"`; exports[`name > 42 > suffix > with gender 1`] = `"III"`; @@ -74,7 +78,7 @@ exports[`name > 1211 > fullName > with lastName 1`] = `"Claude Doe"`; exports[`name > 1211 > gender > noArgs 1`] = `"Trigender"`; -exports[`name > 1211 > gender > with gender 1`] = `"Male"`; +exports[`name > 1211 > gender > with gender 1`] = `"non-binary"`; exports[`name > 1211 > jobArea 1`] = `"Factors"`; @@ -96,6 +100,10 @@ exports[`name > 1211 > prefix > noArgs 1`] = `"Dr."`; exports[`name > 1211 > prefix > with gender 1`] = `"Dr."`; +exports[`name > 1211 > sex > noArgs 1`] = `"non-binary"`; + +exports[`name > 1211 > sex > with gender 1`] = `"non-binary"`; + exports[`name > 1211 > suffix > noArgs 1`] = `"DVM"`; exports[`name > 1211 > suffix > with gender 1`] = `"DVM"`; @@ -124,7 +132,7 @@ exports[`name > 1337 > fullName > with lastName 1`] = `"Leona Doe"`; exports[`name > 1337 > gender > noArgs 1`] = `"Demigender"`; -exports[`name > 1337 > gender > with gender 1`] = `"Female"`; +exports[`name > 1337 > gender > with gender 1`] = `"female"`; exports[`name > 1337 > jobArea 1`] = `"Functionality"`; @@ -146,6 +154,10 @@ exports[`name > 1337 > prefix > noArgs 1`] = `"Mrs."`; exports[`name > 1337 > prefix > with gender 1`] = `"Mrs."`; +exports[`name > 1337 > sex > noArgs 1`] = `"female"`; + +exports[`name > 1337 > sex > with gender 1`] = `"female"`; + exports[`name > 1337 > suffix > noArgs 1`] = `"I"`; exports[`name > 1337 > suffix > with gender 1`] = `"I"`; diff --git a/test/scripts/apidoc/examplesAndDeprecations.spec.ts b/test/scripts/apidoc/examplesAndDeprecations.spec.ts index 314e72d4b42..ab9cf939549 100644 --- a/test/scripts/apidoc/examplesAndDeprecations.spec.ts +++ b/test/scripts/apidoc/examplesAndDeprecations.spec.ts @@ -14,7 +14,7 @@ import { loadProject } from './utils'; /* * This test ensures, that every method * - has working examples - * - and running these does not log anything, unless the method is deprecated + * - and running these do not log anything, unless the method is deprecated */ const locales: Record = { From 6df6e0ed982f62e1ba5acc9042e1781c776647d9 Mon Sep 17 00:00:00 2001 From: Hanna Kuczynska Date: Wed, 3 Aug 2022 12:35:46 +0200 Subject: [PATCH 10/21] chore: rename binary_gender to sex --- src/locales/pl/name/index.ts | 4 ++-- src/locales/pl/name/{binary_gender.ts => sex.ts} | 0 2 files changed, 2 insertions(+), 2 deletions(-) rename src/locales/pl/name/{binary_gender.ts => sex.ts} (100%) diff --git a/src/locales/pl/name/index.ts b/src/locales/pl/name/index.ts index ea7c411a1a9..0d874207b13 100644 --- a/src/locales/pl/name/index.ts +++ b/src/locales/pl/name/index.ts @@ -3,7 +3,6 @@ * Run 'pnpm run generate:locales' to update. */ import type { NameDefinitions } from '../../..'; -import binary_gender from './binary_gender'; import female_first_name from './female_first_name'; import first_name from './first_name'; import gender from './gender'; @@ -11,10 +10,10 @@ import last_name from './last_name'; import male_first_name from './male_first_name'; import name_ from './name'; import prefix from './prefix'; +import sex from './sex'; import title from './title'; const name: NameDefinitions = { - binary_gender, female_first_name, first_name, gender, @@ -22,6 +21,7 @@ const name: NameDefinitions = { male_first_name, name: name_, prefix, + sex, title, }; diff --git a/src/locales/pl/name/binary_gender.ts b/src/locales/pl/name/sex.ts similarity index 100% rename from src/locales/pl/name/binary_gender.ts rename to src/locales/pl/name/sex.ts From 89782051a29e787f9c8bee9b74b303d80cceb3ea Mon Sep 17 00:00:00 2001 From: Hanna Kuczynska Date: Wed, 3 Aug 2022 12:38:28 +0200 Subject: [PATCH 11/21] chore: lowercase pl sex --- src/locales/pl/name/sex.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/locales/pl/name/sex.ts b/src/locales/pl/name/sex.ts index 6754a9f06eb..913a0aa8306 100644 --- a/src/locales/pl/name/sex.ts +++ b/src/locales/pl/name/sex.ts @@ -1 +1 @@ -export default ['Kobieta', 'Mężczyzna']; +export default ['kobieta', 'mężczyzna']; From 1eaa32771dcb82e6268389a7bc1ea756460e12ae Mon Sep 17 00:00:00 2001 From: Hanna Kuczynska Date: Wed, 3 Aug 2022 12:38:43 +0200 Subject: [PATCH 12/21] chore: sex use only 2 values for en --- src/locales/en/name/sex.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/locales/en/name/sex.ts b/src/locales/en/name/sex.ts index 52185d0bd9e..66576370327 100644 --- a/src/locales/en/name/sex.ts +++ b/src/locales/en/name/sex.ts @@ -1 +1 @@ -export default ['female', 'male', 'non-binary']; +export default ['female', 'male']; From 6f1f5a2432e8f465a612e987b53a23bfcd813dbb Mon Sep 17 00:00:00 2001 From: Hanna Kuczynska Date: Wed, 3 Aug 2022 12:40:00 +0200 Subject: [PATCH 13/21] chore: jsdoc --- src/modules/name/index.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/modules/name/index.ts b/src/modules/name/index.ts index f7b43f29bd0..00a2e892e0a 100644 --- a/src/modules/name/index.ts +++ b/src/modules/name/index.ts @@ -268,7 +268,7 @@ export class Name { } /** - * Return a random sex. + * Return a random sex (localised). * * @example * faker.name.sex() // 'female' From 8df8923f77bb9e19f920470d7a01e586c487d672 Mon Sep 17 00:00:00 2001 From: Hanna Kuczynska Date: Wed, 3 Aug 2022 12:45:45 +0200 Subject: [PATCH 14/21] docs: add @see --- src/modules/name/index.ts | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/modules/name/index.ts b/src/modules/name/index.ts index 00a2e892e0a..954df1931e2 100644 --- a/src/modules/name/index.ts +++ b/src/modules/name/index.ts @@ -251,6 +251,8 @@ export class Name { * * @example * faker.name.gender() // 'Trans*Man' + * + * @see faker.name.sex() if you would like to generate binary-gender value */ gender(binary?: boolean): string { if (binary) { @@ -272,6 +274,8 @@ export class Name { * * @example * faker.name.sex() // 'female' + * + * @see faker.name.gender() if you would like to generate gender related values */ sex(): string { return this.faker.helpers.arrayElement(this.faker.definitions.name.sex); From 52d313322d0272ae1c748e7143d5ef03a4492c18 Mon Sep 17 00:00:00 2001 From: Hanna Kuczynska Date: Wed, 3 Aug 2022 12:46:50 +0200 Subject: [PATCH 15/21] docs: change order --- src/modules/name/index.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/modules/name/index.ts b/src/modules/name/index.ts index 954df1931e2..57f014ce6a5 100644 --- a/src/modules/name/index.ts +++ b/src/modules/name/index.ts @@ -249,10 +249,10 @@ export class Name { * * @param binary (deprecated) Whether to return only binary gender names. Defaults to `false`. * + * @see faker.name.sex() if you would like to generate binary-gender value + * * @example * faker.name.gender() // 'Trans*Man' - * - * @see faker.name.sex() if you would like to generate binary-gender value */ gender(binary?: boolean): string { if (binary) { @@ -272,10 +272,10 @@ export class Name { /** * Return a random sex (localised). * + * @see faker.name.gender() if you would like to generate gender related values + * * @example * faker.name.sex() // 'female' - * - * @see faker.name.gender() if you would like to generate gender related values */ sex(): string { return this.faker.helpers.arrayElement(this.faker.definitions.name.sex); From 7d5744a1e15464df073d03e084e9e0563a2cf6e3 Mon Sep 17 00:00:00 2001 From: Hanna Kuczynska Date: Wed, 3 Aug 2022 12:53:49 +0200 Subject: [PATCH 16/21] fix: fixed tests --- test/__snapshots__/name.spec.ts.snap | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/test/__snapshots__/name.spec.ts.snap b/test/__snapshots__/name.spec.ts.snap index b4fb70061fe..ed921dcdfe3 100644 --- a/test/__snapshots__/name.spec.ts.snap +++ b/test/__snapshots__/name.spec.ts.snap @@ -28,7 +28,7 @@ exports[`name > 42 > fullName > with sex 1`] = `"Melanie Schinner"`; exports[`name > 42 > gender > noArgs 1`] = `"Gender nonconforming"`; -exports[`name > 42 > gender > with gender 1`] = `"male"`; +exports[`name > 42 > gender > with gender 1`] = `"female"`; exports[`name > 42 > jobArea 1`] = `"Identity"`; @@ -50,9 +50,9 @@ exports[`name > 42 > prefix > noArgs 1`] = `"Mrs."`; exports[`name > 42 > prefix > with gender 1`] = `"Mrs."`; -exports[`name > 42 > sex > noArgs 1`] = `"male"`; +exports[`name > 42 > sex > noArgs 1`] = `"female"`; -exports[`name > 42 > sex > with gender 1`] = `"male"`; +exports[`name > 42 > sex > with gender 1`] = `"female"`; exports[`name > 42 > suffix > noArgs 1`] = `"III"`; @@ -86,7 +86,7 @@ exports[`name > 1211 > fullName > with sex 1`] = `"Patti Koch"`; exports[`name > 1211 > gender > noArgs 1`] = `"Trigender"`; -exports[`name > 1211 > gender > with gender 1`] = `"non-binary"`; +exports[`name > 1211 > gender > with gender 1`] = `"male"`; exports[`name > 1211 > jobArea 1`] = `"Factors"`; @@ -108,9 +108,9 @@ exports[`name > 1211 > prefix > noArgs 1`] = `"Dr."`; exports[`name > 1211 > prefix > with gender 1`] = `"Dr."`; -exports[`name > 1211 > sex > noArgs 1`] = `"non-binary"`; +exports[`name > 1211 > sex > noArgs 1`] = `"male"`; -exports[`name > 1211 > sex > with gender 1`] = `"non-binary"`; +exports[`name > 1211 > sex > with gender 1`] = `"male"`; exports[`name > 1211 > suffix > noArgs 1`] = `"DVM"`; From e145785d8334a9d30eeb80764b6d99273184fdee Mon Sep 17 00:00:00 2001 From: Hanna Kuczynska Date: Wed, 3 Aug 2022 20:41:00 +0200 Subject: [PATCH 17/21] docs: do not use --- src/modules/name/index.ts | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/modules/name/index.ts b/src/modules/name/index.ts index 57f014ce6a5..104feb33c95 100644 --- a/src/modules/name/index.ts +++ b/src/modules/name/index.ts @@ -270,9 +270,12 @@ export class Name { } /** - * Return a random sex (localised). + * Return a random sex. * - * @see faker.name.gender() if you would like to generate gender related values + * Output of this method is localised, so it should not be used to fill the parameter `sex` + * available in some other modules for example faker.name.firstName(). + * + * @see faker.name.gender() if you would like to generate gender related values. * * @example * faker.name.sex() // 'female' From edaf8c69025ca03244002c3e87dbba52bc4aec8d Mon Sep 17 00:00:00 2001 From: Hanna Kuczynska Date: Wed, 3 Aug 2022 20:44:47 +0200 Subject: [PATCH 18/21] chore: add de --- src/locales/de/name/index.ts | 2 ++ src/locales/de/name/sex.ts | 1 + 2 files changed, 3 insertions(+) create mode 100644 src/locales/de/name/sex.ts diff --git a/src/locales/de/name/index.ts b/src/locales/de/name/index.ts index ffa039e99b9..0c5886c780b 100644 --- a/src/locales/de/name/index.ts +++ b/src/locales/de/name/index.ts @@ -10,6 +10,7 @@ import male_first_name from './male_first_name'; import name_ from './name'; import nobility_title_prefix from './nobility_title_prefix'; import prefix from './prefix'; +import sex from './sex'; const name: NameDefinitions = { female_first_name, @@ -19,6 +20,7 @@ const name: NameDefinitions = { name: name_, nobility_title_prefix, prefix, + sex, }; export default name; diff --git a/src/locales/de/name/sex.ts b/src/locales/de/name/sex.ts new file mode 100644 index 00000000000..c06d0d66da8 --- /dev/null +++ b/src/locales/de/name/sex.ts @@ -0,0 +1 @@ +export default ['männlich', 'weiblich']; From 4fea09d931cced4ffda350887bada0cc7ceb968b Mon Sep 17 00:00:00 2001 From: Hanna <108692126+hankucz@users.noreply.github.com> Date: Thu, 18 Aug 2022 22:52:28 +0200 Subject: [PATCH 19/21] chore: apply feedback Co-authored-by: ST-DDT --- src/modules/name/index.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/modules/name/index.ts b/src/modules/name/index.ts index 104feb33c95..175bc41f74b 100644 --- a/src/modules/name/index.ts +++ b/src/modules/name/index.ts @@ -273,7 +273,7 @@ export class Name { * Return a random sex. * * Output of this method is localised, so it should not be used to fill the parameter `sex` - * available in some other modules for example faker.name.firstName(). + * available in some other modules for example `faker.name.firstName()`. * * @see faker.name.gender() if you would like to generate gender related values. * From da8e56ed464b11e4c2e61881620dc8f37907786c Mon Sep 17 00:00:00 2001 From: Hanna <108692126+hankucz@users.noreply.github.com> Date: Thu, 18 Aug 2022 22:52:49 +0200 Subject: [PATCH 20/21] chore: apply feedback Co-authored-by: ST-DDT --- src/modules/name/index.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/modules/name/index.ts b/src/modules/name/index.ts index 175bc41f74b..ab104b22aa6 100644 --- a/src/modules/name/index.ts +++ b/src/modules/name/index.ts @@ -270,7 +270,7 @@ export class Name { } /** - * Return a random sex. + * Returns a random sex. * * Output of this method is localised, so it should not be used to fill the parameter `sex` * available in some other modules for example `faker.name.firstName()`. From 4665cd09e51a4300002bbbda3eb5b6680c84c540 Mon Sep 17 00:00:00 2001 From: Hanna <108692126+hankucz@users.noreply.github.com> Date: Thu, 18 Aug 2022 22:56:57 +0200 Subject: [PATCH 21/21] chore: apply feedback Co-authored-by: ST-DDT Co-authored-by: Shinigami --- src/modules/name/index.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/modules/name/index.ts b/src/modules/name/index.ts index ab104b22aa6..b42de3db568 100644 --- a/src/modules/name/index.ts +++ b/src/modules/name/index.ts @@ -245,7 +245,7 @@ export class Name { } /** - * Return a random gender. + * Returns a random gender. * * @param binary (deprecated) Whether to return only binary gender names. Defaults to `false`. * @@ -259,7 +259,7 @@ export class Name { deprecated({ deprecated: 'faker.name.gender(true)', proposed: 'faker.name.sex()', - since: '7.4', + since: '7.5', until: '8.0', });