diff --git a/src/definitions/company.ts b/src/definitions/company.ts index 6d70cb36802..257a2912292 100644 --- a/src/definitions/company.ts +++ b/src/definitions/company.ts @@ -5,27 +5,27 @@ import type { LocaleEntry } from './definitions'; */ export type CompanyDefinitions = LocaleEntry<{ /** - * Business/products related adjectives. + * Business/products related adjectives that can be used to demonstrate data being viewed by a manager. */ - bs_adjective: string[]; + buzz_adjective: string[]; /** - * Business/products related nouns. + * Business/products related nouns that can be used to demonstrate data being viewed by a manager. */ - bs_noun: string[]; + buzz_noun: string[]; /** - * Business/products related verbs. + * Business/products related verbs that can be used to demonstrate data being viewed by a manager. */ - bs_verb: string[]; + buzz_verb: string[]; /** - * Catchphrase adjectives. + * Catchphrase adjectives that can be displayed to an end user. */ adjective: string[]; /** - * Catchphrase descriptors. + * Catchphrase descriptors that can be displayed to an end user. */ descriptor: string[]; @@ -35,7 +35,7 @@ export type CompanyDefinitions = LocaleEntry<{ name_patterns: string[]; /** - * Catchphrase nouns. + * Catchphrase nouns that can be displayed to an end user. */ noun: string[]; diff --git a/src/locales/el/company/bs_adjective.ts b/src/locales/el/company/buzz_adjective.ts similarity index 100% rename from src/locales/el/company/bs_adjective.ts rename to src/locales/el/company/buzz_adjective.ts diff --git a/src/locales/el/company/bs_noun.ts b/src/locales/el/company/buzz_noun.ts similarity index 100% rename from src/locales/el/company/bs_noun.ts rename to src/locales/el/company/buzz_noun.ts diff --git a/src/locales/el/company/bs_verb.ts b/src/locales/el/company/buzz_verb.ts similarity index 100% rename from src/locales/el/company/bs_verb.ts rename to src/locales/el/company/buzz_verb.ts diff --git a/src/locales/el/company/index.ts b/src/locales/el/company/index.ts index 7875f08bdbc..ad4d1c3bbdb 100644 --- a/src/locales/el/company/index.ts +++ b/src/locales/el/company/index.ts @@ -4,9 +4,9 @@ */ import type { CompanyDefinitions } from '../../..'; import adjective from './adjective'; -import bs_adjective from './bs_adjective'; -import bs_noun from './bs_noun'; -import bs_verb from './bs_verb'; +import buzz_adjective from './buzz_adjective'; +import buzz_noun from './buzz_noun'; +import buzz_verb from './buzz_verb'; import descriptor from './descriptor'; import name_patterns from './name_patterns'; import noun from './noun'; @@ -14,9 +14,9 @@ import suffix from './suffix'; const company: CompanyDefinitions = { adjective, - bs_adjective, - bs_noun, - bs_verb, + buzz_adjective, + buzz_noun, + buzz_verb, descriptor, name_patterns, noun, diff --git a/src/locales/en/company/bs_adjective.ts b/src/locales/en/company/buzz_adjective.ts similarity index 100% rename from src/locales/en/company/bs_adjective.ts rename to src/locales/en/company/buzz_adjective.ts diff --git a/src/locales/en/company/bs_noun.ts b/src/locales/en/company/buzz_noun.ts similarity index 100% rename from src/locales/en/company/bs_noun.ts rename to src/locales/en/company/buzz_noun.ts diff --git a/src/locales/en/company/bs_verb.ts b/src/locales/en/company/buzz_verb.ts similarity index 100% rename from src/locales/en/company/bs_verb.ts rename to src/locales/en/company/buzz_verb.ts diff --git a/src/locales/en/company/index.ts b/src/locales/en/company/index.ts index 7875f08bdbc..ad4d1c3bbdb 100644 --- a/src/locales/en/company/index.ts +++ b/src/locales/en/company/index.ts @@ -4,9 +4,9 @@ */ import type { CompanyDefinitions } from '../../..'; import adjective from './adjective'; -import bs_adjective from './bs_adjective'; -import bs_noun from './bs_noun'; -import bs_verb from './bs_verb'; +import buzz_adjective from './buzz_adjective'; +import buzz_noun from './buzz_noun'; +import buzz_verb from './buzz_verb'; import descriptor from './descriptor'; import name_patterns from './name_patterns'; import noun from './noun'; @@ -14,9 +14,9 @@ import suffix from './suffix'; const company: CompanyDefinitions = { adjective, - bs_adjective, - bs_noun, - bs_verb, + buzz_adjective, + buzz_noun, + buzz_verb, descriptor, name_patterns, noun, diff --git a/src/locales/es_MX/company/bs_adjective.ts b/src/locales/es_MX/company/buzz_adjective.ts similarity index 100% rename from src/locales/es_MX/company/bs_adjective.ts rename to src/locales/es_MX/company/buzz_adjective.ts diff --git a/src/locales/es_MX/company/bs_noun.ts b/src/locales/es_MX/company/buzz_noun.ts similarity index 100% rename from src/locales/es_MX/company/bs_noun.ts rename to src/locales/es_MX/company/buzz_noun.ts diff --git a/src/locales/es_MX/company/bs_verb.ts b/src/locales/es_MX/company/buzz_verb.ts similarity index 100% rename from src/locales/es_MX/company/bs_verb.ts rename to src/locales/es_MX/company/buzz_verb.ts diff --git a/src/locales/es_MX/company/index.ts b/src/locales/es_MX/company/index.ts index 7875f08bdbc..ad4d1c3bbdb 100644 --- a/src/locales/es_MX/company/index.ts +++ b/src/locales/es_MX/company/index.ts @@ -4,9 +4,9 @@ */ import type { CompanyDefinitions } from '../../..'; import adjective from './adjective'; -import bs_adjective from './bs_adjective'; -import bs_noun from './bs_noun'; -import bs_verb from './bs_verb'; +import buzz_adjective from './buzz_adjective'; +import buzz_noun from './buzz_noun'; +import buzz_verb from './buzz_verb'; import descriptor from './descriptor'; import name_patterns from './name_patterns'; import noun from './noun'; @@ -14,9 +14,9 @@ import suffix from './suffix'; const company: CompanyDefinitions = { adjective, - bs_adjective, - bs_noun, - bs_verb, + buzz_adjective, + buzz_noun, + buzz_verb, descriptor, name_patterns, noun, diff --git a/src/locales/fa/company/bs_adjective.ts b/src/locales/fa/company/buzz_adjective.ts similarity index 100% rename from src/locales/fa/company/bs_adjective.ts rename to src/locales/fa/company/buzz_adjective.ts diff --git a/src/locales/fa/company/bs_noun.ts b/src/locales/fa/company/buzz_noun.ts similarity index 100% rename from src/locales/fa/company/bs_noun.ts rename to src/locales/fa/company/buzz_noun.ts diff --git a/src/locales/fa/company/bs_verb.ts b/src/locales/fa/company/buzz_verb.ts similarity index 100% rename from src/locales/fa/company/bs_verb.ts rename to src/locales/fa/company/buzz_verb.ts diff --git a/src/locales/fa/company/index.ts b/src/locales/fa/company/index.ts index 7875f08bdbc..ad4d1c3bbdb 100644 --- a/src/locales/fa/company/index.ts +++ b/src/locales/fa/company/index.ts @@ -4,9 +4,9 @@ */ import type { CompanyDefinitions } from '../../..'; import adjective from './adjective'; -import bs_adjective from './bs_adjective'; -import bs_noun from './bs_noun'; -import bs_verb from './bs_verb'; +import buzz_adjective from './buzz_adjective'; +import buzz_noun from './buzz_noun'; +import buzz_verb from './buzz_verb'; import descriptor from './descriptor'; import name_patterns from './name_patterns'; import noun from './noun'; @@ -14,9 +14,9 @@ import suffix from './suffix'; const company: CompanyDefinitions = { adjective, - bs_adjective, - bs_noun, - bs_verb, + buzz_adjective, + buzz_noun, + buzz_verb, descriptor, name_patterns, noun, diff --git a/src/locales/fr/company/bs_adjective.ts b/src/locales/fr/company/buzz_adjective.ts similarity index 100% rename from src/locales/fr/company/bs_adjective.ts rename to src/locales/fr/company/buzz_adjective.ts diff --git a/src/locales/fr/company/bs_noun.ts b/src/locales/fr/company/buzz_noun.ts similarity index 100% rename from src/locales/fr/company/bs_noun.ts rename to src/locales/fr/company/buzz_noun.ts diff --git a/src/locales/fr/company/bs_verb.ts b/src/locales/fr/company/buzz_verb.ts similarity index 100% rename from src/locales/fr/company/bs_verb.ts rename to src/locales/fr/company/buzz_verb.ts diff --git a/src/locales/fr/company/index.ts b/src/locales/fr/company/index.ts index 7875f08bdbc..ad4d1c3bbdb 100644 --- a/src/locales/fr/company/index.ts +++ b/src/locales/fr/company/index.ts @@ -4,9 +4,9 @@ */ import type { CompanyDefinitions } from '../../..'; import adjective from './adjective'; -import bs_adjective from './bs_adjective'; -import bs_noun from './bs_noun'; -import bs_verb from './bs_verb'; +import buzz_adjective from './buzz_adjective'; +import buzz_noun from './buzz_noun'; +import buzz_verb from './buzz_verb'; import descriptor from './descriptor'; import name_patterns from './name_patterns'; import noun from './noun'; @@ -14,9 +14,9 @@ import suffix from './suffix'; const company: CompanyDefinitions = { adjective, - bs_adjective, - bs_noun, - bs_verb, + buzz_adjective, + buzz_noun, + buzz_verb, descriptor, name_patterns, noun, diff --git a/src/locales/it/company/bs_adjective.ts b/src/locales/it/company/buzz_adjective.ts similarity index 100% rename from src/locales/it/company/bs_adjective.ts rename to src/locales/it/company/buzz_adjective.ts diff --git a/src/locales/it/company/bs_noun.ts b/src/locales/it/company/buzz_noun.ts similarity index 100% rename from src/locales/it/company/bs_noun.ts rename to src/locales/it/company/buzz_noun.ts diff --git a/src/locales/it/company/bs_verb.ts b/src/locales/it/company/buzz_verb.ts similarity index 100% rename from src/locales/it/company/bs_verb.ts rename to src/locales/it/company/buzz_verb.ts diff --git a/src/locales/it/company/index.ts b/src/locales/it/company/index.ts index 7875f08bdbc..ad4d1c3bbdb 100644 --- a/src/locales/it/company/index.ts +++ b/src/locales/it/company/index.ts @@ -4,9 +4,9 @@ */ import type { CompanyDefinitions } from '../../..'; import adjective from './adjective'; -import bs_adjective from './bs_adjective'; -import bs_noun from './bs_noun'; -import bs_verb from './bs_verb'; +import buzz_adjective from './buzz_adjective'; +import buzz_noun from './buzz_noun'; +import buzz_verb from './buzz_verb'; import descriptor from './descriptor'; import name_patterns from './name_patterns'; import noun from './noun'; @@ -14,9 +14,9 @@ import suffix from './suffix'; const company: CompanyDefinitions = { adjective, - bs_adjective, - bs_noun, - bs_verb, + buzz_adjective, + buzz_noun, + buzz_verb, descriptor, name_patterns, noun, diff --git a/src/locales/pl/company/bs_adjective.ts b/src/locales/pl/company/buzz_adjective.ts similarity index 100% rename from src/locales/pl/company/bs_adjective.ts rename to src/locales/pl/company/buzz_adjective.ts diff --git a/src/locales/pl/company/bs_noun.ts b/src/locales/pl/company/buzz_noun.ts similarity index 100% rename from src/locales/pl/company/bs_noun.ts rename to src/locales/pl/company/buzz_noun.ts diff --git a/src/locales/pl/company/bs_verb.ts b/src/locales/pl/company/buzz_verb.ts similarity index 100% rename from src/locales/pl/company/bs_verb.ts rename to src/locales/pl/company/buzz_verb.ts diff --git a/src/locales/pl/company/index.ts b/src/locales/pl/company/index.ts index 7875f08bdbc..ad4d1c3bbdb 100644 --- a/src/locales/pl/company/index.ts +++ b/src/locales/pl/company/index.ts @@ -4,9 +4,9 @@ */ import type { CompanyDefinitions } from '../../..'; import adjective from './adjective'; -import bs_adjective from './bs_adjective'; -import bs_noun from './bs_noun'; -import bs_verb from './bs_verb'; +import buzz_adjective from './buzz_adjective'; +import buzz_noun from './buzz_noun'; +import buzz_verb from './buzz_verb'; import descriptor from './descriptor'; import name_patterns from './name_patterns'; import noun from './noun'; @@ -14,9 +14,9 @@ import suffix from './suffix'; const company: CompanyDefinitions = { adjective, - bs_adjective, - bs_noun, - bs_verb, + buzz_adjective, + buzz_noun, + buzz_verb, descriptor, name_patterns, noun, diff --git a/src/modules/company/index.ts b/src/modules/company/index.ts index 467256c7697..56c9805004f 100644 --- a/src/modules/company/index.ts +++ b/src/modules/company/index.ts @@ -78,7 +78,7 @@ export class CompanyModule { } /** - * Generates a random business catch phrase. + * Generates a random catch phrase that can be displayed to an end user. * * @example * faker.company.catchPhrase() // 'Upgradable systematic flexibility' @@ -100,13 +100,33 @@ export class CompanyModule { * faker.company.bs() // 'cultivate synergistic e-markets' * * @since 2.0.1 + * + * @deprecated Use `faker.company.buzzPhrase` instead. */ bs(): string { - return [this.bsBuzz(), this.bsAdjective(), this.bsNoun()].join(' '); + deprecated({ + deprecated: 'faker.company.bs', + proposed: 'faker.company.buzzPhrase', + since: '8.0', + until: '9.0', + }); + return this.buzzPhrase(); + } + + /** + * Generates a random buzz phrase that can be used to demonstrate data being viewed by a manager. + * + * @example + * faker.company.buzzPhrase() // 'cultivate synergistic e-markets' + * + * @since 8.0.0 + */ + buzzPhrase(): string { + return [this.buzzVerb(), this.buzzAdjective(), this.buzzNoun()].join(' '); } /** - * Returns a random catch phrase adjective. + * Returns a random catch phrase adjective that can be displayed to an end user.. * * @example * faker.company.catchPhraseAdjective() // 'Multi-tiered' @@ -120,7 +140,7 @@ export class CompanyModule { } /** - * Returns a random catch phrase descriptor. + * Returns a random catch phrase descriptor that can be displayed to an end user.. * * @example * faker.company.catchPhraseDescriptor() // 'composite' @@ -134,7 +154,7 @@ export class CompanyModule { } /** - * Returns a random catch phrase noun. + * Returns a random catch phrase noun that can be displayed to an end user.. * * @example * faker.company.catchPhraseNoun() // 'leverage' @@ -152,10 +172,30 @@ export class CompanyModule { * faker.company.bsAdjective() // 'one-to-one' * * @since 2.0.1 + * + * @deprecated Use `faker.company.buzzAdjective` instead. */ bsAdjective(): string { + deprecated({ + deprecated: 'faker.company.bsAdjective', + proposed: 'faker.company.buzzAdjective', + since: '8.0', + until: '9.0', + }); + return this.buzzAdjective(); + } + + /** + * Returns a random buzz adjective that can be used to demonstrate data being viewed by a manager. + * + * @example + * faker.company.buzzAdjective() // 'one-to-one' + * + * @since 8.0.0 + */ + buzzAdjective(): string { return this.faker.helpers.arrayElement( - this.faker.definitions.company.bs_adjective + this.faker.definitions.company.buzz_adjective ); } @@ -166,10 +206,30 @@ export class CompanyModule { * faker.company.bsBuzz() // 'empower' * * @since 2.0.1 + * + * @deprecated Use `faker.company.buzzVerb` instead. */ bsBuzz(): string { + deprecated({ + deprecated: 'faker.company.bsBuzz', + proposed: 'faker.company.buzzVerb', + since: '8.0', + until: '9.0', + }); + return this.buzzVerb(); + } + + /** + * Returns a random buzz verb that can be used to demonstrate data being viewed by a manager. + * + * @example + * faker.company.buzzVerb() // 'empower' + * + * @since 8.0.0 + */ + buzzVerb(): string { return this.faker.helpers.arrayElement( - this.faker.definitions.company.bs_verb + this.faker.definitions.company.buzz_verb ); } @@ -180,10 +240,30 @@ export class CompanyModule { * faker.company.bsNoun() // 'paradigms' * * @since 2.0.1 + * + * @deprecated Use `faker.company.buzzNoun` instead. */ bsNoun(): string { + deprecated({ + deprecated: 'faker.company.bsNoun', + proposed: 'faker.company.buzzNoun', + since: '8.0', + until: '9.0', + }); + return this.buzzNoun(); + } + + /** + * Returns a random buzz noun that can be used to demonstrate data being viewed by a manager. + * + * @example + * faker.company.buzzNoun() // 'paradigms' + * + * @since 8.0.0 + */ + buzzNoun(): string { return this.faker.helpers.arrayElement( - this.faker.definitions.company.bs_noun + this.faker.definitions.company.buzz_noun ); } } diff --git a/test/__snapshots__/company.spec.ts.snap b/test/__snapshots__/company.spec.ts.snap index 97697afa413..c0a731da729 100644 --- a/test/__snapshots__/company.spec.ts.snap +++ b/test/__snapshots__/company.spec.ts.snap @@ -1,12 +1,12 @@ // Vitest Snapshot v1 -exports[`company > 42 > bs 1`] = `"seize impactful methodologies"`; +exports[`company > 42 > buzzAdjective 1`] = `"dynamic"`; -exports[`company > 42 > bsAdjective 1`] = `"dynamic"`; +exports[`company > 42 > buzzNoun 1`] = `"technologies"`; -exports[`company > 42 > bsBuzz 1`] = `"seize"`; +exports[`company > 42 > buzzPhrase 1`] = `"seize impactful methodologies"`; -exports[`company > 42 > bsNoun 1`] = `"technologies"`; +exports[`company > 42 > buzzVerb 1`] = `"seize"`; exports[`company > 42 > catchPhrase 1`] = `"Implemented responsive throughput"`; @@ -29,13 +29,13 @@ exports[`company > 42 > suffixes 1`] = ` ] `; -exports[`company > 1211 > bs 1`] = `"cultivate bleeding-edge experiences"`; +exports[`company > 1211 > buzzAdjective 1`] = `"plug-and-play"`; -exports[`company > 1211 > bsAdjective 1`] = `"plug-and-play"`; +exports[`company > 1211 > buzzNoun 1`] = `"methodologies"`; -exports[`company > 1211 > bsBuzz 1`] = `"cultivate"`; +exports[`company > 1211 > buzzPhrase 1`] = `"cultivate bleeding-edge experiences"`; -exports[`company > 1211 > bsNoun 1`] = `"methodologies"`; +exports[`company > 1211 > buzzVerb 1`] = `"cultivate"`; exports[`company > 1211 > catchPhrase 1`] = `"Up-sized high-level success"`; @@ -58,13 +58,13 @@ exports[`company > 1211 > suffixes 1`] = ` ] `; -exports[`company > 1337 > bs 1`] = `"incentivize efficient initiatives"`; +exports[`company > 1337 > buzzAdjective 1`] = `"global"`; -exports[`company > 1337 > bsAdjective 1`] = `"global"`; +exports[`company > 1337 > buzzNoun 1`] = `"ROI"`; -exports[`company > 1337 > bsBuzz 1`] = `"incentivize"`; +exports[`company > 1337 > buzzPhrase 1`] = `"incentivize efficient initiatives"`; -exports[`company > 1337 > bsNoun 1`] = `"ROI"`; +exports[`company > 1337 > buzzVerb 1`] = `"incentivize"`; exports[`company > 1337 > catchPhrase 1`] = `"Expanded leading edge capacity"`; diff --git a/test/company.spec.ts b/test/company.spec.ts index 4a57f118a23..211dfe9187c 100644 --- a/test/company.spec.ts +++ b/test/company.spec.ts @@ -15,14 +15,16 @@ describe('company', () => { 'name', 'companySuffix', 'catchPhrase', - 'bs', + 'buzzPhrase', 'catchPhraseAdjective', 'catchPhraseDescriptor', 'catchPhraseNoun', - 'bsAdjective', - 'bsBuzz', - 'bsNoun' + 'buzzAdjective', + 'buzzVerb', + 'buzzNoun' ); + + t.skip('bs').skip('bsAdjective').skip('bsBuzz').skip('bsNoun'); }); describe(`random seeded tests for seed ${faker.seed()}`, () => { @@ -68,9 +70,9 @@ describe('company', () => { }); }); - describe('bs()', () => { - it('should return phrase comprising of a BS buzz, adjective, and noun', () => { - const actual = faker.company.bs(); + describe('buzzPhrase()', () => { + it('should return phrase comprising of a buzz, adjective, and noun', () => { + const actual = faker.company.buzzPhrase(); expect(actual).toBeTruthy(); expect(actual).toBeTypeOf('string'); @@ -111,33 +113,33 @@ describe('company', () => { }); }); - describe('bsAdjective()', () => { - it('should return random value from bs_adjective array', () => { - const actual = faker.company.bsAdjective(); + describe('buzzAdjective()', () => { + it('should return random value from buzz_adjective array', () => { + const actual = faker.company.buzzAdjective(); expect(actual).toBeTruthy(); expect(actual).toBeTypeOf('string'); - expect(faker.definitions.company.bs_adjective).toContain(actual); + expect(faker.definitions.company.buzz_adjective).toContain(actual); }); }); - describe('bsBuzz()', () => { - it('should return random value from bs_verb array', () => { - const actual = faker.company.bsBuzz(); + describe('buzzVerb()', () => { + it('should return random value from buzz_verb array', () => { + const actual = faker.company.buzzVerb(); expect(actual).toBeTruthy(); expect(actual).toBeTypeOf('string'); - expect(faker.definitions.company.bs_verb).toContain(actual); + expect(faker.definitions.company.buzz_verb).toContain(actual); }); }); - describe('bsNoun()', () => { - it('should return random value from bs_noun array', () => { - const actual = faker.company.bsNoun(); + describe('buzzNoun()', () => { + it('should return random value from buzz_noun array', () => { + const actual = faker.company.buzzNoun(); expect(actual).toBeTruthy(); expect(actual).toBeTypeOf('string'); - expect(faker.definitions.company.bs_noun).toContain(actual); + expect(faker.definitions.company.buzz_noun).toContain(actual); }); }); }