diff --git a/docs/guide/upgrading.md b/docs/guide/upgrading.md index 81a48ad8bed..b562cdb096e 100644 --- a/docs/guide/upgrading.md +++ b/docs/guide/upgrading.md @@ -495,13 +495,14 @@ Renamed deprecated locale aliases `cz`, `en_IND`, `ge` and removed `global`. ### Renamed Locale Definitions -The following locale definitions have been renamed +The following locale definitions have been adjusted to align with Faker's locale definition naming standard: | old | replacement | | ------------------------------------------- | -------------------------------------------- | | `faker.definitions.science.chemicalElement` | `faker.definitions.science.chemical_element` | -| `faker.definitions.system.directoryPaths` | `faker.definitions.system.directory_paths` | -| `faker.definitions.system.mimeTypes` | `faker.definitions.system.mime_types` | +| `faker.definitions.system.directoryPaths` | `faker.definitions.system.directory_path` | +| `faker.definitions.system.mimeTypes` | `faker.definitions.system.mime_type` | +| `faker.definitions.lorem.words` | `faker.definitions.lorem.word` | With that now all our locale data use the following naming scheme: diff --git a/src/definitions/lorem.ts b/src/definitions/lorem.ts index 88947a87815..89265b33be2 100644 --- a/src/definitions/lorem.ts +++ b/src/definitions/lorem.ts @@ -7,5 +7,5 @@ export type LoremDefinition = LocaleEntry<{ /** * Lorem words used to generate dummy texts. */ - words: string[]; + word: string[]; }>; diff --git a/src/definitions/system.ts b/src/definitions/system.ts index 72f5c98a7d1..16578a43dd6 100644 --- a/src/definitions/system.ts +++ b/src/definitions/system.ts @@ -7,12 +7,12 @@ export type SystemDefinition = LocaleEntry<{ /** * Returns some common file paths. */ - directory_paths: string[]; + directory_path: string[]; /** * The mime type definitions with some additional information. */ - mime_types: { [mimeType: string]: SystemMimeTypeEntryDefinition }; + mime_type: { [mimeType: string]: SystemMimeTypeEntryDefinition }; }>; /** diff --git a/src/locales/ar/lorem/index.ts b/src/locales/ar/lorem/index.ts index 2e093406a2b..fd79f833a72 100644 --- a/src/locales/ar/lorem/index.ts +++ b/src/locales/ar/lorem/index.ts @@ -3,10 +3,10 @@ * Run 'pnpm run generate:locales' to update. */ import type { LoremDefinition } from '../../..'; -import words from './words'; +import word from './word'; const lorem: LoremDefinition = { - words, + word, }; export default lorem; diff --git a/src/locales/ar/lorem/words.ts b/src/locales/ar/lorem/word.ts similarity index 100% rename from src/locales/ar/lorem/words.ts rename to src/locales/ar/lorem/word.ts diff --git a/src/locales/base/system/directory_paths.ts b/src/locales/base/system/directory_path.ts similarity index 100% rename from src/locales/base/system/directory_paths.ts rename to src/locales/base/system/directory_path.ts diff --git a/src/locales/base/system/index.ts b/src/locales/base/system/index.ts index 5d6a50968a2..2fa04691ed7 100644 --- a/src/locales/base/system/index.ts +++ b/src/locales/base/system/index.ts @@ -3,12 +3,12 @@ * Run 'pnpm run generate:locales' to update. */ import type { SystemDefinition } from '../../..'; -import directory_paths from './directory_paths'; -import mime_types from './mime_types'; +import directory_path from './directory_path'; +import mime_type from './mime_type'; const system: SystemDefinition = { - directory_paths, - mime_types, + directory_path, + mime_type, }; export default system; diff --git a/src/locales/base/system/mime_types.ts b/src/locales/base/system/mime_type.ts similarity index 100% rename from src/locales/base/system/mime_types.ts rename to src/locales/base/system/mime_type.ts diff --git a/src/locales/cs_CZ/lorem/index.ts b/src/locales/cs_CZ/lorem/index.ts index 2e093406a2b..fd79f833a72 100644 --- a/src/locales/cs_CZ/lorem/index.ts +++ b/src/locales/cs_CZ/lorem/index.ts @@ -3,10 +3,10 @@ * Run 'pnpm run generate:locales' to update. */ import type { LoremDefinition } from '../../..'; -import words from './words'; +import word from './word'; const lorem: LoremDefinition = { - words, + word, }; export default lorem; diff --git a/src/locales/cs_CZ/lorem/words.ts b/src/locales/cs_CZ/lorem/word.ts similarity index 100% rename from src/locales/cs_CZ/lorem/words.ts rename to src/locales/cs_CZ/lorem/word.ts diff --git a/src/locales/de/lorem/index.ts b/src/locales/de/lorem/index.ts index 2e093406a2b..fd79f833a72 100644 --- a/src/locales/de/lorem/index.ts +++ b/src/locales/de/lorem/index.ts @@ -3,10 +3,10 @@ * Run 'pnpm run generate:locales' to update. */ import type { LoremDefinition } from '../../..'; -import words from './words'; +import word from './word'; const lorem: LoremDefinition = { - words, + word, }; export default lorem; diff --git a/src/locales/de/lorem/words.ts b/src/locales/de/lorem/word.ts similarity index 100% rename from src/locales/de/lorem/words.ts rename to src/locales/de/lorem/word.ts diff --git a/src/locales/dv/lorem/index.ts b/src/locales/dv/lorem/index.ts index 2e093406a2b..fd79f833a72 100644 --- a/src/locales/dv/lorem/index.ts +++ b/src/locales/dv/lorem/index.ts @@ -3,10 +3,10 @@ * Run 'pnpm run generate:locales' to update. */ import type { LoremDefinition } from '../../..'; -import words from './words'; +import word from './word'; const lorem: LoremDefinition = { - words, + word, }; export default lorem; diff --git a/src/locales/dv/lorem/words.ts b/src/locales/dv/lorem/word.ts similarity index 100% rename from src/locales/dv/lorem/words.ts rename to src/locales/dv/lorem/word.ts diff --git a/src/locales/el/lorem/index.ts b/src/locales/el/lorem/index.ts index 2e093406a2b..fd79f833a72 100644 --- a/src/locales/el/lorem/index.ts +++ b/src/locales/el/lorem/index.ts @@ -3,10 +3,10 @@ * Run 'pnpm run generate:locales' to update. */ import type { LoremDefinition } from '../../..'; -import words from './words'; +import word from './word'; const lorem: LoremDefinition = { - words, + word, }; export default lorem; diff --git a/src/locales/el/lorem/words.ts b/src/locales/el/lorem/word.ts similarity index 100% rename from src/locales/el/lorem/words.ts rename to src/locales/el/lorem/word.ts diff --git a/src/locales/en/lorem/index.ts b/src/locales/en/lorem/index.ts index 2e093406a2b..fd79f833a72 100644 --- a/src/locales/en/lorem/index.ts +++ b/src/locales/en/lorem/index.ts @@ -3,10 +3,10 @@ * Run 'pnpm run generate:locales' to update. */ import type { LoremDefinition } from '../../..'; -import words from './words'; +import word from './word'; const lorem: LoremDefinition = { - words, + word, }; export default lorem; diff --git a/src/locales/en/lorem/words.ts b/src/locales/en/lorem/word.ts similarity index 100% rename from src/locales/en/lorem/words.ts rename to src/locales/en/lorem/word.ts diff --git a/src/locales/en_BORK/lorem/index.ts b/src/locales/en_BORK/lorem/index.ts index 2e093406a2b..fd79f833a72 100644 --- a/src/locales/en_BORK/lorem/index.ts +++ b/src/locales/en_BORK/lorem/index.ts @@ -3,10 +3,10 @@ * Run 'pnpm run generate:locales' to update. */ import type { LoremDefinition } from '../../..'; -import words from './words'; +import word from './word'; const lorem: LoremDefinition = { - words, + word, }; export default lorem; diff --git a/src/locales/en_BORK/lorem/words.ts b/src/locales/en_BORK/lorem/word.ts similarity index 100% rename from src/locales/en_BORK/lorem/words.ts rename to src/locales/en_BORK/lorem/word.ts diff --git a/src/locales/es_MX/lorem/index.ts b/src/locales/es_MX/lorem/index.ts index 2e093406a2b..fd79f833a72 100644 --- a/src/locales/es_MX/lorem/index.ts +++ b/src/locales/es_MX/lorem/index.ts @@ -3,10 +3,10 @@ * Run 'pnpm run generate:locales' to update. */ import type { LoremDefinition } from '../../..'; -import words from './words'; +import word from './word'; const lorem: LoremDefinition = { - words, + word, }; export default lorem; diff --git a/src/locales/es_MX/lorem/words.ts b/src/locales/es_MX/lorem/word.ts similarity index 100% rename from src/locales/es_MX/lorem/words.ts rename to src/locales/es_MX/lorem/word.ts diff --git a/src/locales/fa/lorem/index.ts b/src/locales/fa/lorem/index.ts index 2e093406a2b..fd79f833a72 100644 --- a/src/locales/fa/lorem/index.ts +++ b/src/locales/fa/lorem/index.ts @@ -3,10 +3,10 @@ * Run 'pnpm run generate:locales' to update. */ import type { LoremDefinition } from '../../..'; -import words from './words'; +import word from './word'; const lorem: LoremDefinition = { - words, + word, }; export default lorem; diff --git a/src/locales/fa/lorem/words.ts b/src/locales/fa/lorem/word.ts similarity index 100% rename from src/locales/fa/lorem/words.ts rename to src/locales/fa/lorem/word.ts diff --git a/src/locales/fr/lorem/index.ts b/src/locales/fr/lorem/index.ts index 2e093406a2b..fd79f833a72 100644 --- a/src/locales/fr/lorem/index.ts +++ b/src/locales/fr/lorem/index.ts @@ -3,10 +3,10 @@ * Run 'pnpm run generate:locales' to update. */ import type { LoremDefinition } from '../../..'; -import words from './words'; +import word from './word'; const lorem: LoremDefinition = { - words, + word, }; export default lorem; diff --git a/src/locales/fr/lorem/words.ts b/src/locales/fr/lorem/word.ts similarity index 100% rename from src/locales/fr/lorem/words.ts rename to src/locales/fr/lorem/word.ts diff --git a/src/locales/fr_CH/lorem/index.ts b/src/locales/fr_CH/lorem/index.ts index 2e093406a2b..fd79f833a72 100644 --- a/src/locales/fr_CH/lorem/index.ts +++ b/src/locales/fr_CH/lorem/index.ts @@ -3,10 +3,10 @@ * Run 'pnpm run generate:locales' to update. */ import type { LoremDefinition } from '../../..'; -import words from './words'; +import word from './word'; const lorem: LoremDefinition = { - words, + word, }; export default lorem; diff --git a/src/locales/fr_CH/lorem/words.ts b/src/locales/fr_CH/lorem/word.ts similarity index 100% rename from src/locales/fr_CH/lorem/words.ts rename to src/locales/fr_CH/lorem/word.ts diff --git a/src/locales/he/lorem/index.ts b/src/locales/he/lorem/index.ts index 2e093406a2b..fd79f833a72 100644 --- a/src/locales/he/lorem/index.ts +++ b/src/locales/he/lorem/index.ts @@ -3,10 +3,10 @@ * Run 'pnpm run generate:locales' to update. */ import type { LoremDefinition } from '../../..'; -import words from './words'; +import word from './word'; const lorem: LoremDefinition = { - words, + word, }; export default lorem; diff --git a/src/locales/he/lorem/words.ts b/src/locales/he/lorem/word.ts similarity index 100% rename from src/locales/he/lorem/words.ts rename to src/locales/he/lorem/word.ts diff --git a/src/locales/hy/lorem/index.ts b/src/locales/hy/lorem/index.ts index 2e093406a2b..fd79f833a72 100644 --- a/src/locales/hy/lorem/index.ts +++ b/src/locales/hy/lorem/index.ts @@ -3,10 +3,10 @@ * Run 'pnpm run generate:locales' to update. */ import type { LoremDefinition } from '../../..'; -import words from './words'; +import word from './word'; const lorem: LoremDefinition = { - words, + word, }; export default lorem; diff --git a/src/locales/hy/lorem/words.ts b/src/locales/hy/lorem/word.ts similarity index 100% rename from src/locales/hy/lorem/words.ts rename to src/locales/hy/lorem/word.ts diff --git a/src/locales/ja/lorem/index.ts b/src/locales/ja/lorem/index.ts index 2e093406a2b..fd79f833a72 100644 --- a/src/locales/ja/lorem/index.ts +++ b/src/locales/ja/lorem/index.ts @@ -3,10 +3,10 @@ * Run 'pnpm run generate:locales' to update. */ import type { LoremDefinition } from '../../..'; -import words from './words'; +import word from './word'; const lorem: LoremDefinition = { - words, + word, }; export default lorem; diff --git a/src/locales/ja/lorem/words.ts b/src/locales/ja/lorem/word.ts similarity index 100% rename from src/locales/ja/lorem/words.ts rename to src/locales/ja/lorem/word.ts diff --git a/src/locales/ko/lorem/index.ts b/src/locales/ko/lorem/index.ts index 2e093406a2b..fd79f833a72 100644 --- a/src/locales/ko/lorem/index.ts +++ b/src/locales/ko/lorem/index.ts @@ -3,10 +3,10 @@ * Run 'pnpm run generate:locales' to update. */ import type { LoremDefinition } from '../../..'; -import words from './words'; +import word from './word'; const lorem: LoremDefinition = { - words, + word, }; export default lorem; diff --git a/src/locales/ko/lorem/words.ts b/src/locales/ko/lorem/word.ts similarity index 100% rename from src/locales/ko/lorem/words.ts rename to src/locales/ko/lorem/word.ts diff --git a/src/locales/lv/lorem/index.ts b/src/locales/lv/lorem/index.ts index 2e093406a2b..fd79f833a72 100644 --- a/src/locales/lv/lorem/index.ts +++ b/src/locales/lv/lorem/index.ts @@ -3,10 +3,10 @@ * Run 'pnpm run generate:locales' to update. */ import type { LoremDefinition } from '../../..'; -import words from './words'; +import word from './word'; const lorem: LoremDefinition = { - words, + word, }; export default lorem; diff --git a/src/locales/lv/lorem/words.ts b/src/locales/lv/lorem/word.ts similarity index 100% rename from src/locales/lv/lorem/words.ts rename to src/locales/lv/lorem/word.ts diff --git a/src/locales/nl/lorem/index.ts b/src/locales/nl/lorem/index.ts index 2e093406a2b..fd79f833a72 100644 --- a/src/locales/nl/lorem/index.ts +++ b/src/locales/nl/lorem/index.ts @@ -3,10 +3,10 @@ * Run 'pnpm run generate:locales' to update. */ import type { LoremDefinition } from '../../..'; -import words from './words'; +import word from './word'; const lorem: LoremDefinition = { - words, + word, }; export default lorem; diff --git a/src/locales/nl/lorem/words.ts b/src/locales/nl/lorem/word.ts similarity index 100% rename from src/locales/nl/lorem/words.ts rename to src/locales/nl/lorem/word.ts diff --git a/src/locales/pl/lorem/index.ts b/src/locales/pl/lorem/index.ts index 2e093406a2b..fd79f833a72 100644 --- a/src/locales/pl/lorem/index.ts +++ b/src/locales/pl/lorem/index.ts @@ -3,10 +3,10 @@ * Run 'pnpm run generate:locales' to update. */ import type { LoremDefinition } from '../../..'; -import words from './words'; +import word from './word'; const lorem: LoremDefinition = { - words, + word, }; export default lorem; diff --git a/src/locales/pl/lorem/words.ts b/src/locales/pl/lorem/word.ts similarity index 100% rename from src/locales/pl/lorem/words.ts rename to src/locales/pl/lorem/word.ts diff --git a/src/locales/pt_BR/lorem/index.ts b/src/locales/pt_BR/lorem/index.ts index 2e093406a2b..fd79f833a72 100644 --- a/src/locales/pt_BR/lorem/index.ts +++ b/src/locales/pt_BR/lorem/index.ts @@ -3,10 +3,10 @@ * Run 'pnpm run generate:locales' to update. */ import type { LoremDefinition } from '../../..'; -import words from './words'; +import word from './word'; const lorem: LoremDefinition = { - words, + word, }; export default lorem; diff --git a/src/locales/pt_BR/lorem/words.ts b/src/locales/pt_BR/lorem/word.ts similarity index 100% rename from src/locales/pt_BR/lorem/words.ts rename to src/locales/pt_BR/lorem/word.ts diff --git a/src/locales/ru/lorem/index.ts b/src/locales/ru/lorem/index.ts index 2e093406a2b..fd79f833a72 100644 --- a/src/locales/ru/lorem/index.ts +++ b/src/locales/ru/lorem/index.ts @@ -3,10 +3,10 @@ * Run 'pnpm run generate:locales' to update. */ import type { LoremDefinition } from '../../..'; -import words from './words'; +import word from './word'; const lorem: LoremDefinition = { - words, + word, }; export default lorem; diff --git a/src/locales/ru/lorem/words.ts b/src/locales/ru/lorem/word.ts similarity index 100% rename from src/locales/ru/lorem/words.ts rename to src/locales/ru/lorem/word.ts diff --git a/src/locales/sk/lorem/index.ts b/src/locales/sk/lorem/index.ts index 2e093406a2b..fd79f833a72 100644 --- a/src/locales/sk/lorem/index.ts +++ b/src/locales/sk/lorem/index.ts @@ -3,10 +3,10 @@ * Run 'pnpm run generate:locales' to update. */ import type { LoremDefinition } from '../../..'; -import words from './words'; +import word from './word'; const lorem: LoremDefinition = { - words, + word, }; export default lorem; diff --git a/src/locales/sk/lorem/words.ts b/src/locales/sk/lorem/word.ts similarity index 100% rename from src/locales/sk/lorem/words.ts rename to src/locales/sk/lorem/word.ts diff --git a/src/locales/tr/lorem/index.ts b/src/locales/tr/lorem/index.ts index 2e093406a2b..fd79f833a72 100644 --- a/src/locales/tr/lorem/index.ts +++ b/src/locales/tr/lorem/index.ts @@ -3,10 +3,10 @@ * Run 'pnpm run generate:locales' to update. */ import type { LoremDefinition } from '../../..'; -import words from './words'; +import word from './word'; const lorem: LoremDefinition = { - words, + word, }; export default lorem; diff --git a/src/locales/tr/lorem/words.ts b/src/locales/tr/lorem/word.ts similarity index 100% rename from src/locales/tr/lorem/words.ts rename to src/locales/tr/lorem/word.ts diff --git a/src/locales/ur/lorem/index.ts b/src/locales/ur/lorem/index.ts index 2e093406a2b..fd79f833a72 100644 --- a/src/locales/ur/lorem/index.ts +++ b/src/locales/ur/lorem/index.ts @@ -3,10 +3,10 @@ * Run 'pnpm run generate:locales' to update. */ import type { LoremDefinition } from '../../..'; -import words from './words'; +import word from './word'; const lorem: LoremDefinition = { - words, + word, }; export default lorem; diff --git a/src/locales/ur/lorem/words.ts b/src/locales/ur/lorem/word.ts similarity index 100% rename from src/locales/ur/lorem/words.ts rename to src/locales/ur/lorem/word.ts diff --git a/src/locales/uz_UZ_latin/lorem/index.ts b/src/locales/uz_UZ_latin/lorem/index.ts index 2e093406a2b..fd79f833a72 100644 --- a/src/locales/uz_UZ_latin/lorem/index.ts +++ b/src/locales/uz_UZ_latin/lorem/index.ts @@ -3,10 +3,10 @@ * Run 'pnpm run generate:locales' to update. */ import type { LoremDefinition } from '../../..'; -import words from './words'; +import word from './word'; const lorem: LoremDefinition = { - words, + word, }; export default lorem; diff --git a/src/locales/uz_UZ_latin/lorem/words.ts b/src/locales/uz_UZ_latin/lorem/word.ts similarity index 100% rename from src/locales/uz_UZ_latin/lorem/words.ts rename to src/locales/uz_UZ_latin/lorem/word.ts diff --git a/src/locales/vi/lorem/index.ts b/src/locales/vi/lorem/index.ts index 2e093406a2b..fd79f833a72 100644 --- a/src/locales/vi/lorem/index.ts +++ b/src/locales/vi/lorem/index.ts @@ -3,10 +3,10 @@ * Run 'pnpm run generate:locales' to update. */ import type { LoremDefinition } from '../../..'; -import words from './words'; +import word from './word'; const lorem: LoremDefinition = { - words, + word, }; export default lorem; diff --git a/src/locales/vi/lorem/words.ts b/src/locales/vi/lorem/word.ts similarity index 100% rename from src/locales/vi/lorem/words.ts rename to src/locales/vi/lorem/word.ts diff --git a/src/modules/lorem/index.ts b/src/modules/lorem/index.ts index 1f9ba026327..785b5a960d3 100644 --- a/src/modules/lorem/index.ts +++ b/src/modules/lorem/index.ts @@ -79,7 +79,7 @@ export class LoremModule extends ModuleBase { return this.faker.helpers.arrayElement( filterWordListByLength({ ...opts, - wordList: this.faker.definitions.lorem.words, + wordList: this.faker.definitions.lorem.word, }) ); } diff --git a/src/modules/system/index.ts b/src/modules/system/index.ts index 1fcc9be3271..57d52ca26e0 100644 --- a/src/modules/system/index.ts +++ b/src/modules/system/index.ts @@ -114,7 +114,7 @@ export class SystemModule extends ModuleBase { * @since 3.1.0 */ mimeType(): string { - const mimeTypeKeys = Object.keys(this.faker.definitions.system.mime_types); + const mimeTypeKeys = Object.keys(this.faker.definitions.system.mime_type); return this.faker.helpers.arrayElement(mimeTypeKeys); } @@ -152,7 +152,7 @@ export class SystemModule extends ModuleBase { * @since 3.1.0 */ fileType(): string { - const mimeTypes = this.faker.definitions.system.mime_types; + const mimeTypes = this.faker.definitions.system.mime_type; const typeSet = new Set( Object.keys(mimeTypes).map((key) => key.split('/')[0]) @@ -172,7 +172,7 @@ export class SystemModule extends ModuleBase { * @since 3.1.0 */ fileExt(mimeType?: string): string { - const mimeTypes = this.faker.definitions.system.mime_types; + const mimeTypes = this.faker.definitions.system.mime_type; if (typeof mimeType === 'string') { return this.faker.helpers.arrayElement(mimeTypes[mimeType].extensions); @@ -193,7 +193,7 @@ export class SystemModule extends ModuleBase { * @since 3.1.0 */ directoryPath(): string { - const paths = this.faker.definitions.system.directory_paths; + const paths = this.faker.definitions.system.directory_path; return this.faker.helpers.arrayElement(paths); } diff --git a/test/modules/lorem.spec.ts b/test/modules/lorem.spec.ts index 39a9a1442ce..4f5c5aba2b5 100644 --- a/test/modules/lorem.spec.ts +++ b/test/modules/lorem.spec.ts @@ -43,7 +43,7 @@ describe('lorem', () => { expect(actual).toBeTruthy(); expect(actual).toBeTypeOf('string'); - expect(faker.definitions.lorem.words).toContain(actual); + expect(faker.definitions.lorem.word).toContain(actual); }); // INFO @Shinigami92 2022-02-11: Seems there are only words with a max length of 14 characters @@ -54,7 +54,7 @@ describe('lorem', () => { expect(actual).toBeTruthy(); expect(actual).toBeTypeOf('string'); - expect(faker.definitions.lorem.words).toContain(actual); + expect(faker.definitions.lorem.word).toContain(actual); expect(actual).toHaveLength(length); } ); @@ -72,7 +72,7 @@ describe('lorem', () => { expect(words).toHaveLength(3); for (const word of words) { - expect(faker.definitions.lorem.words).toContain(word); + expect(faker.definitions.lorem.word).toContain(word); } }); @@ -89,7 +89,7 @@ describe('lorem', () => { expect(words).toHaveLength(num); for (const word of words) { - expect(faker.definitions.lorem.words).toContain(word); + expect(faker.definitions.lorem.word).toContain(word); } } ); @@ -106,7 +106,7 @@ describe('lorem', () => { expect(words.length).toBeLessThanOrEqual(20); for (const word of words) { - expect(faker.definitions.lorem.words).toContain(word); + expect(faker.definitions.lorem.word).toContain(word); } }); });