From 558b959e0e2f791dab0ba2f500493ba7ddbd25e2 Mon Sep 17 00:00:00 2001
From: ST-DDT <ST-DDT@gmx.de>
Date: Sat, 25 May 2024 21:45:31 +0200
Subject: [PATCH] refactor(locale)!: use snake case for all locale data (#2910)

---
 .eslintrc.cjs                                 |  6 -----
 docs/guide/upgrading.md                       | 22 +++++++++++++++++++
 src/definitions/science.ts                    |  2 +-
 src/definitions/system.ts                     |  4 ++--
 .../{directoryPaths.ts => directory_paths.ts} |  0
 src/locales/base/system/index.ts              |  8 +++----
 .../system/{mimeTypes.ts => mime_types.ts}    |  0
 ...chemicalElement.ts => chemical_element.ts} |  0
 src/locales/en/science/index.ts               |  4 ++--
 ...chemicalElement.ts => chemical_element.ts} |  0
 src/locales/eo/science/index.ts               |  4 ++--
 ...chemicalElement.ts => chemical_element.ts} |  0
 src/locales/nb_NO/science/index.ts            |  4 ++--
 ...chemicalElement.ts => chemical_element.ts} |  0
 src/locales/pl/science/index.ts               |  4 ++--
 ...chemicalElement.ts => chemical_element.ts} |  0
 src/locales/zh_CN/science/index.ts            |  4 ++--
 src/modules/science/index.ts                  |  2 +-
 src/modules/system/index.ts                   |  8 +++----
 test/modules/science.spec.ts                  |  6 ++---
 20 files changed, 47 insertions(+), 31 deletions(-)
 rename src/locales/base/system/{directoryPaths.ts => directory_paths.ts} (100%)
 rename src/locales/base/system/{mimeTypes.ts => mime_types.ts} (100%)
 rename src/locales/en/science/{chemicalElement.ts => chemical_element.ts} (100%)
 rename src/locales/eo/science/{chemicalElement.ts => chemical_element.ts} (100%)
 rename src/locales/nb_NO/science/{chemicalElement.ts => chemical_element.ts} (100%)
 rename src/locales/pl/science/{chemicalElement.ts => chemical_element.ts} (100%)
 rename src/locales/zh_CN/science/{chemicalElement.ts => chemical_element.ts} (100%)

diff --git a/.eslintrc.cjs b/.eslintrc.cjs
index a5cb75ff9d8..a7a7d168978 100644
--- a/.eslintrc.cjs
+++ b/.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',
diff --git a/docs/guide/upgrading.md b/docs/guide/upgrading.md
index 1981c501276..653570b6eba 100644
--- a/docs/guide/upgrading.md
+++ b/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
diff --git a/src/definitions/science.ts b/src/definitions/science.ts
index a2fa995b73c..01f791f8a9d 100644
--- a/src/definitions/science.ts
+++ b/src/definitions/science.ts
@@ -13,5 +13,5 @@ export type ScienceDefinition = LocaleEntry<{
   /**
    * Some periodic table element information.
    */
-  chemicalElement: ReadonlyArray<ChemicalElement>;
+  chemical_element: ReadonlyArray<ChemicalElement>;
 }>;
diff --git a/src/definitions/system.ts b/src/definitions/system.ts
index 86868c632ad..72f5c98a7d1 100644
--- a/src/definitions/system.ts
+++ b/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 };
 }>;
 
 /**
diff --git a/src/locales/base/system/directoryPaths.ts b/src/locales/base/system/directory_paths.ts
similarity index 100%
rename from src/locales/base/system/directoryPaths.ts
rename to src/locales/base/system/directory_paths.ts
diff --git a/src/locales/base/system/index.ts b/src/locales/base/system/index.ts
index 122bee499c7..5d6a50968a2 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 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;
diff --git a/src/locales/base/system/mimeTypes.ts b/src/locales/base/system/mime_types.ts
similarity index 100%
rename from src/locales/base/system/mimeTypes.ts
rename to src/locales/base/system/mime_types.ts
diff --git a/src/locales/en/science/chemicalElement.ts b/src/locales/en/science/chemical_element.ts
similarity index 100%
rename from src/locales/en/science/chemicalElement.ts
rename to src/locales/en/science/chemical_element.ts
diff --git a/src/locales/en/science/index.ts b/src/locales/en/science/index.ts
index 86f8dd2f47e..91968423bbf 100644
--- a/src/locales/en/science/index.ts
+++ b/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,
 };
 
diff --git a/src/locales/eo/science/chemicalElement.ts b/src/locales/eo/science/chemical_element.ts
similarity index 100%
rename from src/locales/eo/science/chemicalElement.ts
rename to src/locales/eo/science/chemical_element.ts
diff --git a/src/locales/eo/science/index.ts b/src/locales/eo/science/index.ts
index 86f8dd2f47e..91968423bbf 100644
--- a/src/locales/eo/science/index.ts
+++ b/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,
 };
 
diff --git a/src/locales/nb_NO/science/chemicalElement.ts b/src/locales/nb_NO/science/chemical_element.ts
similarity index 100%
rename from src/locales/nb_NO/science/chemicalElement.ts
rename to src/locales/nb_NO/science/chemical_element.ts
diff --git a/src/locales/nb_NO/science/index.ts b/src/locales/nb_NO/science/index.ts
index 86f8dd2f47e..91968423bbf 100644
--- a/src/locales/nb_NO/science/index.ts
+++ b/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,
 };
 
diff --git a/src/locales/pl/science/chemicalElement.ts b/src/locales/pl/science/chemical_element.ts
similarity index 100%
rename from src/locales/pl/science/chemicalElement.ts
rename to src/locales/pl/science/chemical_element.ts
diff --git a/src/locales/pl/science/index.ts b/src/locales/pl/science/index.ts
index 86f8dd2f47e..91968423bbf 100644
--- a/src/locales/pl/science/index.ts
+++ b/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,
 };
 
diff --git a/src/locales/zh_CN/science/chemicalElement.ts b/src/locales/zh_CN/science/chemical_element.ts
similarity index 100%
rename from src/locales/zh_CN/science/chemicalElement.ts
rename to src/locales/zh_CN/science/chemical_element.ts
diff --git a/src/locales/zh_CN/science/index.ts b/src/locales/zh_CN/science/index.ts
index 86f8dd2f47e..91968423bbf 100644
--- a/src/locales/zh_CN/science/index.ts
+++ b/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,
 };
 
diff --git a/src/modules/science/index.ts b/src/modules/science/index.ts
index 26c78014786..525ff8bf0cc 100644
--- a/src/modules/science/index.ts
+++ b/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
     );
   }
 
diff --git a/src/modules/system/index.ts b/src/modules/system/index.ts
index 3468bbb0a79..1fcc9be3271 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.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);
   }
 
diff --git a/test/modules/science.spec.ts b/test/modules/science.spec.ts
index 80002c1968f..051fecbb3cf 100644
--- a/test/modules/science.spec.ts
+++ b/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();