refactor(locale)!: use snake case for all locale data (#2910)

.eslintrc.cjs

@@ -164,12 +164,6 @@ module.exports = defineConfig({
           'error',
           {
             case: 'snakeCase',
-            // TODO @ST-DDT 2023-10-21: rename the definitions in v9
-            ignore: [
-              /chemicalElement\.ts$/,
-              /directoryPaths\.ts$/,
-              /mimeTypes\.ts$/,
-            ],
           },
         ],
         'unicorn/text-encoding-identifier-case': 'off',

docs/guide/upgrading.md

@@ -480,6 +480,28 @@ Renamed deprecated locale aliases `cz`, `en_IND`, `ge` and removed `global`.
 | `import { faker } from '@faker-js/faker/locale/ge'`     | `import { faker } from '@faker-js/faker/locale/ka_GE'` |
 | `import { faker } from '@faker-js/faker/locale/global'` | `import { faker } from '@faker-js/faker/locale/base'`  |
 
+### Renamed Locale Definitions
+
+The following locale definitions have been renamed
+
+| 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`        |
+
+With that now all our locale data use the following naming scheme:
+
+```txt
+faker.definitions.category_name.entry_name
+```
+
+Please keep in mind that property keys of complex objects remain in camel-case.
+
+```txt
+faker.definitions.science.chemical_element.atomicNumber
+```
+
 ### Type Aliases
 
 Removed deprecated type aliases

src/definitions/science.ts

@@ -13,5 +13,5 @@ export type ScienceDefinition = LocaleEntry<{
   /**
    * Some periodic table element information.
    */
-  chemicalElement: ReadonlyArray<ChemicalElement>;
+  chemical_element: ReadonlyArray<ChemicalElement>;
 }>;

src/definitions/system.ts

@@ -7,12 +7,12 @@ export type SystemDefinition = LocaleEntry<{
   /**
    * Returns some common file paths.
    */
-  directoryPaths: string[];
+  directory_paths: string[];
 
   /**
    * The mime type definitions with some additional information.
    */
-  mimeTypes: { [mimeType: string]: SystemMimeTypeEntryDefinition };
+  mime_types: { [mimeType: string]: SystemMimeTypeEntryDefinition };
 }>;
 
 /**

src/locales/base/system/index.ts

@@ -3,12 +3,12 @@
  * Run 'pnpm run generate:locales' to update.
  */
 import type { SystemDefinition } from '../../..';
-import directoryPaths from './directoryPaths';
-import mimeTypes from './mimeTypes';
+import directory_paths from './directory_paths';
+import mime_types from './mime_types';
 
 const system: SystemDefinition = {
-  directoryPaths,
-  mimeTypes,
+  directory_paths,
+  mime_types,
 };
 
 export default system;

src/locales/en/science/index.ts

@@ -3,11 +3,11 @@
  * Run 'pnpm run generate:locales' to update.
  */
 import type { ScienceDefinition } from '../../..';
-import chemicalElement from './chemicalElement';
+import chemical_element from './chemical_element';
 import unit from './unit';
 
 const science: ScienceDefinition = {
-  chemicalElement,
+  chemical_element,
   unit,
 };
 

src/locales/eo/science/index.ts

@@ -3,11 +3,11 @@
  * Run 'pnpm run generate:locales' to update.
  */
 import type { ScienceDefinition } from '../../..';
-import chemicalElement from './chemicalElement';
+import chemical_element from './chemical_element';
 import unit from './unit';
 
 const science: ScienceDefinition = {
-  chemicalElement,
+  chemical_element,
   unit,
 };
 

src/locales/nb_NO/science/index.ts

@@ -3,11 +3,11 @@
  * Run 'pnpm run generate:locales' to update.
  */
 import type { ScienceDefinition } from '../../..';
-import chemicalElement from './chemicalElement';
+import chemical_element from './chemical_element';
 import unit from './unit';
 
 const science: ScienceDefinition = {
-  chemicalElement,
+  chemical_element,
   unit,
 };
 

src/locales/pl/science/index.ts

@@ -3,11 +3,11 @@
  * Run 'pnpm run generate:locales' to update.
  */
 import type { ScienceDefinition } from '../../..';
-import chemicalElement from './chemicalElement';
+import chemical_element from './chemical_element';
 import unit from './unit';
 
 const science: ScienceDefinition = {
-  chemicalElement,
+  chemical_element,
   unit,
 };
 

src/locales/zh_CN/science/index.ts

@@ -3,11 +3,11 @@
  * Run 'pnpm run generate:locales' to update.
  */
 import type { ScienceDefinition } from '../../..';
-import chemicalElement from './chemicalElement';
+import chemical_element from './chemical_element';
 import unit from './unit';
 
 const science: ScienceDefinition = {
-  chemicalElement,
+  chemical_element,
   unit,
 };
 

src/modules/science/index.ts

@@ -49,7 +49,7 @@ export class ScienceModule extends ModuleBase {
    */
   chemicalElement(): ChemicalElement {
     return this.faker.helpers.arrayElement(
-      this.faker.definitions.science.chemicalElement
+      this.faker.definitions.science.chemical_element
     );
   }
 

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.mimeTypes);
+    const mimeTypeKeys = Object.keys(this.faker.definitions.system.mime_types);
 
     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.mimeTypes;
+    const mimeTypes = this.faker.definitions.system.mime_types;
 
     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.mimeTypes;
+    const mimeTypes = this.faker.definitions.system.mime_types;
 
     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.directoryPaths;
+    const paths = this.faker.definitions.system.directory_paths;
     return this.faker.helpers.arrayElement(paths);
   }
 

test/modules/science.spec.ts

@@ -28,7 +28,7 @@ describe('science', () => {
 
           expect(name).toBeTypeOf('string');
           expect(() => {
-            faker.definitions.science.chemicalElement.find(
+            faker.definitions.science.chemical_element.find(
               (element) => element.name === name
             );
           }).toBeTruthy();
@@ -39,7 +39,7 @@ describe('science', () => {
 
           expect(symbol).toBeTypeOf('string');
           expect(() => {
-            faker.definitions.science.chemicalElement.find(
+            faker.definitions.science.chemical_element.find(
               (element) => element.symbol === symbol
             );
           }).toBeTruthy();
@@ -50,7 +50,7 @@ describe('science', () => {
 
           expect(atomicNumber).toBeTypeOf('number');
           expect(() => {
-            faker.definitions.science.chemicalElement.find(
+            faker.definitions.science.chemical_element.find(
               (element) => element.atomicNumber === atomicNumber
             );
           }).toBeTruthy();