diff --git a/src/definitions/company.ts b/src/definitions/company.ts index 946d224bbc2..83806c7416c 100644 --- a/src/definitions/company.ts +++ b/src/definitions/company.ts @@ -29,6 +29,11 @@ export type CompanyDefinitions = LocaleEntry<{ */ descriptor: string[]; + /** + * A list of patterns used to generate company names. + */ + name_patterns: string[]; + /** * Catchphrase adjectives. */ diff --git a/src/locales/az/company/index.ts b/src/locales/az/company/index.ts index 6e91a4e29b3..4e399166244 100644 --- a/src/locales/az/company/index.ts +++ b/src/locales/az/company/index.ts @@ -3,12 +3,12 @@ * Run 'pnpm run generate:locales' to update. */ import type { CompanyDefinitions } from '../../..'; -import name_ from './name'; +import name_patterns from './name_patterns'; import prefix from './prefix'; import suffix from './suffix'; const company: CompanyDefinitions = { - name: name_, + name_patterns, prefix, suffix, }; diff --git a/src/locales/az/company/name.ts b/src/locales/az/company/name_patterns.ts similarity index 100% rename from src/locales/az/company/name.ts rename to src/locales/az/company/name_patterns.ts diff --git a/src/locales/cz/company/index.ts b/src/locales/cz/company/index.ts index 1b69a9d158d..27ef3afce63 100644 --- a/src/locales/cz/company/index.ts +++ b/src/locales/cz/company/index.ts @@ -7,7 +7,7 @@ import adjective from './adjective'; import bs_noun from './bs_noun'; import bs_verb from './bs_verb'; import descriptor from './descriptor'; -import name_ from './name'; +import name_patterns from './name_patterns'; import noun from './noun'; import suffix from './suffix'; @@ -16,7 +16,7 @@ const company: CompanyDefinitions = { bs_noun, bs_verb, descriptor, - name: name_, + name_patterns, noun, suffix, }; diff --git a/src/locales/cz/company/name.ts b/src/locales/cz/company/name_patterns.ts similarity index 100% rename from src/locales/cz/company/name.ts rename to src/locales/cz/company/name_patterns.ts diff --git a/src/locales/de/company/index.ts b/src/locales/de/company/index.ts index 312df0c6384..453ccf5fe20 100644 --- a/src/locales/de/company/index.ts +++ b/src/locales/de/company/index.ts @@ -4,12 +4,12 @@ */ import type { CompanyDefinitions } from '../../..'; import legal_form from './legal_form'; -import name_ from './name'; +import name_patterns from './name_patterns'; import suffix from './suffix'; const company: CompanyDefinitions = { legal_form, - name: name_, + name_patterns, suffix, }; diff --git a/src/locales/de/company/name.ts b/src/locales/de/company/name_patterns.ts similarity index 100% rename from src/locales/de/company/name.ts rename to src/locales/de/company/name_patterns.ts diff --git a/src/locales/de_AT/company/index.ts b/src/locales/de_AT/company/index.ts index 312df0c6384..453ccf5fe20 100644 --- a/src/locales/de_AT/company/index.ts +++ b/src/locales/de_AT/company/index.ts @@ -4,12 +4,12 @@ */ import type { CompanyDefinitions } from '../../..'; import legal_form from './legal_form'; -import name_ from './name'; +import name_patterns from './name_patterns'; import suffix from './suffix'; const company: CompanyDefinitions = { legal_form, - name: name_, + name_patterns, suffix, }; diff --git a/src/locales/de_AT/company/name.ts b/src/locales/de_AT/company/name_patterns.ts similarity index 100% rename from src/locales/de_AT/company/name.ts rename to src/locales/de_AT/company/name_patterns.ts diff --git a/src/locales/de_CH/company/index.ts b/src/locales/de_CH/company/index.ts index f3027330988..94e1daa3406 100644 --- a/src/locales/de_CH/company/index.ts +++ b/src/locales/de_CH/company/index.ts @@ -3,11 +3,11 @@ * Run 'pnpm run generate:locales' to update. */ import type { CompanyDefinitions } from '../../..'; -import name_ from './name'; +import name_patterns from './name_patterns'; import suffix from './suffix'; const company: CompanyDefinitions = { - name: name_, + name_patterns, suffix, }; diff --git a/src/locales/de_CH/company/name.ts b/src/locales/de_CH/company/name_patterns.ts similarity index 100% rename from src/locales/de_CH/company/name.ts rename to src/locales/de_CH/company/name_patterns.ts diff --git a/src/locales/el/company/index.ts b/src/locales/el/company/index.ts index abdbc9f5334..7875f08bdbc 100644 --- a/src/locales/el/company/index.ts +++ b/src/locales/el/company/index.ts @@ -8,7 +8,7 @@ import bs_adjective from './bs_adjective'; import bs_noun from './bs_noun'; import bs_verb from './bs_verb'; import descriptor from './descriptor'; -import name_ from './name'; +import name_patterns from './name_patterns'; import noun from './noun'; import suffix from './suffix'; @@ -18,7 +18,7 @@ const company: CompanyDefinitions = { bs_noun, bs_verb, descriptor, - name: name_, + name_patterns, noun, suffix, }; diff --git a/src/locales/el/company/name.ts b/src/locales/el/company/name_patterns.ts similarity index 100% rename from src/locales/el/company/name.ts rename to src/locales/el/company/name_patterns.ts diff --git a/src/locales/en/company/index.ts b/src/locales/en/company/index.ts index abdbc9f5334..7875f08bdbc 100644 --- a/src/locales/en/company/index.ts +++ b/src/locales/en/company/index.ts @@ -8,7 +8,7 @@ import bs_adjective from './bs_adjective'; import bs_noun from './bs_noun'; import bs_verb from './bs_verb'; import descriptor from './descriptor'; -import name_ from './name'; +import name_patterns from './name_patterns'; import noun from './noun'; import suffix from './suffix'; @@ -18,7 +18,7 @@ const company: CompanyDefinitions = { bs_noun, bs_verb, descriptor, - name: name_, + name_patterns, noun, suffix, }; diff --git a/src/locales/pl/company/name.ts b/src/locales/en/company/name_patterns.ts similarity index 74% rename from src/locales/pl/company/name.ts rename to src/locales/en/company/name_patterns.ts index cffd6e7018a..2acb30ea348 100644 --- a/src/locales/pl/company/name.ts +++ b/src/locales/en/company/name_patterns.ts @@ -1,5 +1,5 @@ export default [ '{{name.last_name}} {{company.suffix}}', - '{{name.last_name}}-{{name.last_name}}', + '{{name.last_name}} - {{name.last_name}}', '{{name.last_name}}, {{name.last_name}} and {{name.last_name}}', ]; diff --git a/src/locales/en_GH/company/index.ts b/src/locales/en_GH/company/index.ts index f3027330988..94e1daa3406 100644 --- a/src/locales/en_GH/company/index.ts +++ b/src/locales/en_GH/company/index.ts @@ -3,11 +3,11 @@ * Run 'pnpm run generate:locales' to update. */ import type { CompanyDefinitions } from '../../..'; -import name_ from './name'; +import name_patterns from './name_patterns'; import suffix from './suffix'; const company: CompanyDefinitions = { - name: name_, + name_patterns, suffix, }; diff --git a/src/locales/en_GH/company/name.ts b/src/locales/en_GH/company/name_patterns.ts similarity index 100% rename from src/locales/en_GH/company/name.ts rename to src/locales/en_GH/company/name_patterns.ts diff --git a/src/locales/es/company/index.ts b/src/locales/es/company/index.ts index 401e3548761..8b8ebbc4bad 100644 --- a/src/locales/es/company/index.ts +++ b/src/locales/es/company/index.ts @@ -5,14 +5,14 @@ import type { CompanyDefinitions } from '../../..'; import adjective from './adjective'; import descriptor from './descriptor'; -import name_ from './name'; +import name_patterns from './name_patterns'; import noun from './noun'; import suffix from './suffix'; const company: CompanyDefinitions = { adjective, descriptor, - name: name_, + name_patterns, noun, suffix, }; diff --git a/src/locales/es/company/name.ts b/src/locales/es/company/name_patterns.ts similarity index 100% rename from src/locales/es/company/name.ts rename to src/locales/es/company/name_patterns.ts diff --git a/src/locales/es_MX/company/index.ts b/src/locales/es_MX/company/index.ts index abdbc9f5334..7875f08bdbc 100644 --- a/src/locales/es_MX/company/index.ts +++ b/src/locales/es_MX/company/index.ts @@ -8,7 +8,7 @@ import bs_adjective from './bs_adjective'; import bs_noun from './bs_noun'; import bs_verb from './bs_verb'; import descriptor from './descriptor'; -import name_ from './name'; +import name_patterns from './name_patterns'; import noun from './noun'; import suffix from './suffix'; @@ -18,7 +18,7 @@ const company: CompanyDefinitions = { bs_noun, bs_verb, descriptor, - name: name_, + name_patterns, noun, suffix, }; diff --git a/src/locales/es_MX/company/name.ts b/src/locales/es_MX/company/name_patterns.ts similarity index 100% rename from src/locales/es_MX/company/name.ts rename to src/locales/es_MX/company/name_patterns.ts diff --git a/src/locales/fa/company/index.ts b/src/locales/fa/company/index.ts index abdbc9f5334..7875f08bdbc 100644 --- a/src/locales/fa/company/index.ts +++ b/src/locales/fa/company/index.ts @@ -8,7 +8,7 @@ import bs_adjective from './bs_adjective'; import bs_noun from './bs_noun'; import bs_verb from './bs_verb'; import descriptor from './descriptor'; -import name_ from './name'; +import name_patterns from './name_patterns'; import noun from './noun'; import suffix from './suffix'; @@ -18,7 +18,7 @@ const company: CompanyDefinitions = { bs_noun, bs_verb, descriptor, - name: name_, + name_patterns, noun, suffix, }; diff --git a/src/locales/fa/company/name.ts b/src/locales/fa/company/name_patterns.ts similarity index 100% rename from src/locales/fa/company/name.ts rename to src/locales/fa/company/name_patterns.ts diff --git a/src/locales/fr/company/index.ts b/src/locales/fr/company/index.ts index abdbc9f5334..7875f08bdbc 100644 --- a/src/locales/fr/company/index.ts +++ b/src/locales/fr/company/index.ts @@ -8,7 +8,7 @@ import bs_adjective from './bs_adjective'; import bs_noun from './bs_noun'; import bs_verb from './bs_verb'; import descriptor from './descriptor'; -import name_ from './name'; +import name_patterns from './name_patterns'; import noun from './noun'; import suffix from './suffix'; @@ -18,7 +18,7 @@ const company: CompanyDefinitions = { bs_noun, bs_verb, descriptor, - name: name_, + name_patterns, noun, suffix, }; diff --git a/src/locales/fr/company/name.ts b/src/locales/fr/company/name_patterns.ts similarity index 100% rename from src/locales/fr/company/name.ts rename to src/locales/fr/company/name_patterns.ts diff --git a/src/locales/ge/company/index.ts b/src/locales/ge/company/index.ts index 6e91a4e29b3..4e399166244 100644 --- a/src/locales/ge/company/index.ts +++ b/src/locales/ge/company/index.ts @@ -3,12 +3,12 @@ * Run 'pnpm run generate:locales' to update. */ import type { CompanyDefinitions } from '../../..'; -import name_ from './name'; +import name_patterns from './name_patterns'; import prefix from './prefix'; import suffix from './suffix'; const company: CompanyDefinitions = { - name: name_, + name_patterns, prefix, suffix, }; diff --git a/src/locales/ge/company/name.ts b/src/locales/ge/company/name_patterns.ts similarity index 100% rename from src/locales/ge/company/name.ts rename to src/locales/ge/company/name_patterns.ts diff --git a/src/locales/id_ID/company/index.ts b/src/locales/id_ID/company/index.ts index 6e91a4e29b3..4e399166244 100644 --- a/src/locales/id_ID/company/index.ts +++ b/src/locales/id_ID/company/index.ts @@ -3,12 +3,12 @@ * Run 'pnpm run generate:locales' to update. */ import type { CompanyDefinitions } from '../../..'; -import name_ from './name'; +import name_patterns from './name_patterns'; import prefix from './prefix'; import suffix from './suffix'; const company: CompanyDefinitions = { - name: name_, + name_patterns, prefix, suffix, }; diff --git a/src/locales/id_ID/company/name.ts b/src/locales/id_ID/company/name_patterns.ts similarity index 100% rename from src/locales/id_ID/company/name.ts rename to src/locales/id_ID/company/name_patterns.ts diff --git a/src/locales/it/company/index.ts b/src/locales/it/company/index.ts index abdbc9f5334..7875f08bdbc 100644 --- a/src/locales/it/company/index.ts +++ b/src/locales/it/company/index.ts @@ -8,7 +8,7 @@ import bs_adjective from './bs_adjective'; import bs_noun from './bs_noun'; import bs_verb from './bs_verb'; import descriptor from './descriptor'; -import name_ from './name'; +import name_patterns from './name_patterns'; import noun from './noun'; import suffix from './suffix'; @@ -18,7 +18,7 @@ const company: CompanyDefinitions = { bs_noun, bs_verb, descriptor, - name: name_, + name_patterns, noun, suffix, }; diff --git a/src/locales/it/company/name.ts b/src/locales/it/company/name_patterns.ts similarity index 100% rename from src/locales/it/company/name.ts rename to src/locales/it/company/name_patterns.ts diff --git a/src/locales/ko/company/index.ts b/src/locales/ko/company/index.ts index 6e91a4e29b3..4e399166244 100644 --- a/src/locales/ko/company/index.ts +++ b/src/locales/ko/company/index.ts @@ -3,12 +3,12 @@ * Run 'pnpm run generate:locales' to update. */ import type { CompanyDefinitions } from '../../..'; -import name_ from './name'; +import name_patterns from './name_patterns'; import prefix from './prefix'; import suffix from './suffix'; const company: CompanyDefinitions = { - name: name_, + name_patterns, prefix, suffix, }; diff --git a/src/locales/ko/company/name.ts b/src/locales/ko/company/name_patterns.ts similarity index 100% rename from src/locales/ko/company/name.ts rename to src/locales/ko/company/name_patterns.ts diff --git a/src/locales/lv/company/index.ts b/src/locales/lv/company/index.ts index 6e91a4e29b3..4e399166244 100644 --- a/src/locales/lv/company/index.ts +++ b/src/locales/lv/company/index.ts @@ -3,12 +3,12 @@ * Run 'pnpm run generate:locales' to update. */ import type { CompanyDefinitions } from '../../..'; -import name_ from './name'; +import name_patterns from './name_patterns'; import prefix from './prefix'; import suffix from './suffix'; const company: CompanyDefinitions = { - name: name_, + name_patterns, prefix, suffix, }; diff --git a/src/locales/lv/company/name.ts b/src/locales/lv/company/name_patterns.ts similarity index 100% rename from src/locales/lv/company/name.ts rename to src/locales/lv/company/name_patterns.ts diff --git a/src/locales/mk/company/index.ts b/src/locales/mk/company/index.ts index f3027330988..94e1daa3406 100644 --- a/src/locales/mk/company/index.ts +++ b/src/locales/mk/company/index.ts @@ -3,11 +3,11 @@ * Run 'pnpm run generate:locales' to update. */ import type { CompanyDefinitions } from '../../..'; -import name_ from './name'; +import name_patterns from './name_patterns'; import suffix from './suffix'; const company: CompanyDefinitions = { - name: name_, + name_patterns, suffix, }; diff --git a/src/locales/mk/company/name.ts b/src/locales/mk/company/name_patterns.ts similarity index 100% rename from src/locales/mk/company/name.ts rename to src/locales/mk/company/name_patterns.ts diff --git a/src/locales/nb_NO/company/index.ts b/src/locales/nb_NO/company/index.ts index f3027330988..94e1daa3406 100644 --- a/src/locales/nb_NO/company/index.ts +++ b/src/locales/nb_NO/company/index.ts @@ -3,11 +3,11 @@ * Run 'pnpm run generate:locales' to update. */ import type { CompanyDefinitions } from '../../..'; -import name_ from './name'; +import name_patterns from './name_patterns'; import suffix from './suffix'; const company: CompanyDefinitions = { - name: name_, + name_patterns, suffix, }; diff --git a/src/locales/nb_NO/company/name.ts b/src/locales/nb_NO/company/name_patterns.ts similarity index 100% rename from src/locales/nb_NO/company/name.ts rename to src/locales/nb_NO/company/name_patterns.ts diff --git a/src/locales/pl/company/index.ts b/src/locales/pl/company/index.ts index abdbc9f5334..7875f08bdbc 100644 --- a/src/locales/pl/company/index.ts +++ b/src/locales/pl/company/index.ts @@ -8,7 +8,7 @@ import bs_adjective from './bs_adjective'; import bs_noun from './bs_noun'; import bs_verb from './bs_verb'; import descriptor from './descriptor'; -import name_ from './name'; +import name_patterns from './name_patterns'; import noun from './noun'; import suffix from './suffix'; @@ -18,7 +18,7 @@ const company: CompanyDefinitions = { bs_noun, bs_verb, descriptor, - name: name_, + name_patterns, noun, suffix, }; diff --git a/src/locales/en/company/name.ts b/src/locales/pl/company/name_patterns.ts similarity index 100% rename from src/locales/en/company/name.ts rename to src/locales/pl/company/name_patterns.ts diff --git a/src/locales/pt_BR/company/index.ts b/src/locales/pt_BR/company/index.ts index f3027330988..94e1daa3406 100644 --- a/src/locales/pt_BR/company/index.ts +++ b/src/locales/pt_BR/company/index.ts @@ -3,11 +3,11 @@ * Run 'pnpm run generate:locales' to update. */ import type { CompanyDefinitions } from '../../..'; -import name_ from './name'; +import name_patterns from './name_patterns'; import suffix from './suffix'; const company: CompanyDefinitions = { - name: name_, + name_patterns, suffix, }; diff --git a/src/locales/pt_BR/company/name.ts b/src/locales/pt_BR/company/name_patterns.ts similarity index 100% rename from src/locales/pt_BR/company/name.ts rename to src/locales/pt_BR/company/name_patterns.ts diff --git a/src/locales/ru/company/index.ts b/src/locales/ru/company/index.ts index 6e91a4e29b3..4e399166244 100644 --- a/src/locales/ru/company/index.ts +++ b/src/locales/ru/company/index.ts @@ -3,12 +3,12 @@ * Run 'pnpm run generate:locales' to update. */ import type { CompanyDefinitions } from '../../..'; -import name_ from './name'; +import name_patterns from './name_patterns'; import prefix from './prefix'; import suffix from './suffix'; const company: CompanyDefinitions = { - name: name_, + name_patterns, prefix, suffix, }; diff --git a/src/locales/ru/company/name.ts b/src/locales/ru/company/name_patterns.ts similarity index 100% rename from src/locales/ru/company/name.ts rename to src/locales/ru/company/name_patterns.ts diff --git a/src/locales/sk/company/index.ts b/src/locales/sk/company/index.ts index 1b69a9d158d..27ef3afce63 100644 --- a/src/locales/sk/company/index.ts +++ b/src/locales/sk/company/index.ts @@ -7,7 +7,7 @@ import adjective from './adjective'; import bs_noun from './bs_noun'; import bs_verb from './bs_verb'; import descriptor from './descriptor'; -import name_ from './name'; +import name_patterns from './name_patterns'; import noun from './noun'; import suffix from './suffix'; @@ -16,7 +16,7 @@ const company: CompanyDefinitions = { bs_noun, bs_verb, descriptor, - name: name_, + name_patterns, noun, suffix, }; diff --git a/src/locales/sk/company/name.ts b/src/locales/sk/company/name_patterns.ts similarity index 100% rename from src/locales/sk/company/name.ts rename to src/locales/sk/company/name_patterns.ts diff --git a/src/locales/sv/company/index.ts b/src/locales/sv/company/index.ts index f3027330988..94e1daa3406 100644 --- a/src/locales/sv/company/index.ts +++ b/src/locales/sv/company/index.ts @@ -3,11 +3,11 @@ * Run 'pnpm run generate:locales' to update. */ import type { CompanyDefinitions } from '../../..'; -import name_ from './name'; +import name_patterns from './name_patterns'; import suffix from './suffix'; const company: CompanyDefinitions = { - name: name_, + name_patterns, suffix, }; diff --git a/src/locales/sv/company/name.ts b/src/locales/sv/company/name_patterns.ts similarity index 100% rename from src/locales/sv/company/name.ts rename to src/locales/sv/company/name_patterns.ts diff --git a/src/locales/uk/company/index.ts b/src/locales/uk/company/index.ts index 6e91a4e29b3..4e399166244 100644 --- a/src/locales/uk/company/index.ts +++ b/src/locales/uk/company/index.ts @@ -3,12 +3,12 @@ * Run 'pnpm run generate:locales' to update. */ import type { CompanyDefinitions } from '../../..'; -import name_ from './name'; +import name_patterns from './name_patterns'; import prefix from './prefix'; import suffix from './suffix'; const company: CompanyDefinitions = { - name: name_, + name_patterns, prefix, suffix, }; diff --git a/src/locales/uk/company/name.ts b/src/locales/uk/company/name_patterns.ts similarity index 100% rename from src/locales/uk/company/name.ts rename to src/locales/uk/company/name_patterns.ts diff --git a/src/locales/vi/company/index.ts b/src/locales/vi/company/index.ts index eeb7716083a..ff850f20334 100644 --- a/src/locales/vi/company/index.ts +++ b/src/locales/vi/company/index.ts @@ -3,11 +3,11 @@ * Run 'pnpm run generate:locales' to update. */ import type { CompanyDefinitions } from '../../..'; -import name_ from './name'; +import name_patterns from './name_patterns'; import prefix from './prefix'; const company: CompanyDefinitions = { - name: name_, + name_patterns, prefix, }; diff --git a/src/locales/vi/company/name.ts b/src/locales/vi/company/name_patterns.ts similarity index 100% rename from src/locales/vi/company/name.ts rename to src/locales/vi/company/name_patterns.ts diff --git a/src/modules/company/index.ts b/src/modules/company/index.ts index 0a164fec98b..2a8b2db922e 100644 --- a/src/modules/company/index.ts +++ b/src/modules/company/index.ts @@ -35,21 +35,24 @@ export class Company { * faker.company.name() // 'Zieme, Hauck and McClure' */ name(format?: number): string { - const formats = [ - '{{name.lastName}} {{company.companySuffix}}', - '{{name.lastName}} - {{name.lastName}}', - '{{name.lastName}}, {{name.lastName}} and {{name.lastName}}', - ]; - if (format != null) { deprecated({ deprecated: 'faker.company.name(format)', - proposed: 'faker.company.name()', + proposed: 'faker.company.name() or faker.helpers.fake(format)', since: '7.4', until: '8.0', }); } + // ToDo: This `staticFormats` pattern should be removed in the future. It is only used to maintain backwards compatibility. + const staticFormats = [ + '{{name.lastName}} {{company.companySuffix}}', + '{{name.lastName}} - {{name.lastName}}', + '{{name.lastName}}, {{name.lastName}} and {{name.lastName}}', + ]; + const formats = + this.faker.definitions.company.name_patterns ?? staticFormats; + if (typeof format !== 'number') { format = this.faker.datatype.number(formats.length - 1); }