refactor(locale)!: use singular locale definition keys (#2932)

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:
 

src/definitions/lorem.ts

@@ -7,5 +7,5 @@ export type LoremDefinition = LocaleEntry<{
   /**
    * Lorem words used to generate dummy texts.
    */
-  words: string[];
+  word: string[];
 }>;

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 };
 }>;
 
 /**

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;

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;

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;

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;

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;

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;

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;

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;

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;

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;

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;

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;

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;

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;

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;

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;

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;

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;

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;

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;

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;

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;

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;

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;

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;

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;

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,
       })
     );
   }