refactor(locale)!: move title to metadata

scripts/generateLocales.ts

@@ -23,7 +23,7 @@ import { resolve } from 'node:path';
 import type { Options } from 'prettier';
 import { format } from 'prettier';
 import options from '../.prettierrc.cjs';
-import type { Definitions, LocaleDefinition } from '../src/definitions';
+import type { Definitions } from '../src/definitions';
 
 // Constants
 
@@ -64,6 +64,7 @@ const definitionsTypes: DefinitionsType = {
   internet: 'InternetDefinitions',
   location: 'LocationDefinitions',
   lorem: 'LoremDefinitions',
+  metadata: 'MetadataDefinitions',
   music: 'MusicDefinitions',
   person: 'PersonDefinitions',
   phone_number: 'PhoneNumberDefinitions',
@@ -148,40 +149,11 @@ function generateLocaleFile(locale: string): void {
   writeFileSync(resolve(pathLocale, `${locale}.ts`), content);
 }
 
-function tryLoadLocalesMainIndexFile(pathModules: string): LocaleDefinition {
-  let localeDef: LocaleDefinition;
-  // This call might fail, if the module setup is broken.
-  // Unfortunately, we try to fix it with this script
-  // Thats why have a fallback logic here, we only need the title anyway
-  try {
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
-    localeDef = require(pathModules).default;
-  } catch (e) {
-    try {
-      console.log(
-        `Failed to load ${pathModules}. Attempting manual parse instead...`
-      );
-      const localeIndex = readFileSync(
-        resolve(pathModules, 'index.ts'),
-        'utf-8'
-      );
-      localeDef = {
-        title: localeIndex.match(/title: '(.*)',/)[1],
-      };
-    } catch {
-      console.error(`Failed to load ${pathModules} or manually parse it.`, e);
-    }
-  }
-
-  return localeDef;
-}
-
 function generateLocalesIndexFile(
   path: string,
   name: string,
   type: string,
-  depth: number,
-  extra: string = ''
+  depth: number
 ): void {
   let modules = readdirSync(path);
   modules = removeIndexTs(modules);
@@ -206,7 +178,6 @@ function generateLocalesIndexFile(
   );
 
   content.push(`\nconst ${name}${fieldType} = {
-        ${extra}
         ${modules.map((module) => `${escapeField(name, module)},`).join('\n')}
       };\n`);
 
@@ -222,10 +193,9 @@ function generateRecursiveModuleIndexes(
   path: string,
   name: string,
   definition: string,
-  depth: number,
-  extra?: string
+  depth: number
 ): void {
-  generateLocalesIndexFile(path, name, definition, depth, extra);
+  generateLocalesIndexFile(path, name, definition, depth);
 
   let submodules = readdirSync(path);
   submodules = removeIndexTs(submodules);
@@ -247,8 +217,7 @@ function generateRecursiveModuleIndexes(
         pathModule,
         submodule,
         moduleDefinition,
-        depth + 1,
-        undefined
+        depth + 1
       );
     }
   }
@@ -303,10 +272,16 @@ let localizationLocales = '| Locale | Name | Faker |\n| :--- | :--- | :--- |\n';
 
 for (const locale of locales) {
   const pathModules = resolve(pathLocales, locale);
-
-  const localeDef = tryLoadLocalesMainIndexFile(pathModules);
-  // We use a fallback here to at least generate a working file.
-  const localeTitle = localeDef?.title ?? `TODO: Insert Title for ${locale}`;
+  const pathTitle = resolve(pathModules, 'metadata', 'title.ts');
+  let localeTitle = 'No title found';
+  try {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    localeTitle = require(pathTitle).default as string;
+  } catch (e) {
+    console.log(
+      `Failed to load ${pathTitle}. Please make sure the file exists and exports a string.`
+    );
+  }
 
   const localizedFaker = `faker${locale.replace(/^([a-z]+)/, (part) =>
     part.toUpperCase()
@@ -322,13 +297,7 @@ for (const locale of locales) {
   generateLocaleFile(locale);
 
   // src/locales/**/index.ts
-  generateRecursiveModuleIndexes(
-    pathModules,
-    locale,
-    'LocaleDefinition',
-    1,
-    `title: '${localeTitle}',`
-  );
+  generateRecursiveModuleIndexes(pathModules, locale, 'LocaleDefinition', 1);
 }
 
 // src/locale/index.ts

src/definitions/definitions.ts

@@ -10,6 +10,7 @@ import type { HackerDefinitions } from './hacker';
 import type { InternetDefinitions } from './internet';
 import type { LocationDefinitions } from './location';
 import type { LoremDefinitions } from './lorem';
+import type { MetadataDefinitions } from './metadata';
 import type { MusicDefinitions } from './music';
 import type { PersonDefinitions } from './person';
 import type { PhoneNumberDefinitions } from './phone_number';
@@ -20,8 +21,7 @@ import type { WordDefinitions } from './word';
 
 export type LocaleEntry<T> = Partial<T> &
   // Unsupported & custom modules
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  Record<string, any>;
+  Record<string, unknown>;
 
 /**
  * The definitions as used by the Faker modules.
@@ -39,6 +39,7 @@ export interface Definitions {
   internet: InternetDefinitions;
   location: LocationDefinitions;
   lorem: LoremDefinitions;
+  metadata: MetadataDefinitions;
   music: MusicDefinitions;
   person: PersonDefinitions;
   phone_number: PhoneNumberDefinitions;
@@ -54,8 +55,6 @@ export interface Definitions {
  * that most properties are optional and extra properties are allowed.
  */
 export type LocaleDefinition = {
-  /**
-   * The English name of the language (and the specific country, if defined).
-   */
-  title: string;
-} & LocaleEntry<Definitions>;
+  metadata: MetadataDefinitions;
+} & Partial<Definitions> &
+  Record<string, Record<string, unknown>>;

src/definitions/index.ts

@@ -14,6 +14,7 @@ export type { HackerDefinitions } from './hacker';
 export type { InternetDefinitions } from './internet';
 export type { LocationDefinitions } from './location';
 export type { LoremDefinitions } from './lorem';
+export type { MetadataDefinitions } from './metadata';
 export type { MusicDefinitions } from './music';
 export type { PersonDefinitions, PersonTitleDefinitions } from './person';
 export type { PhoneNumberDefinitions } from './phone_number';

src/definitions/metadata.ts

@@ -0,0 +1,6 @@
+export type MetadataDefinitions = {
+  /**
+   * The English name of the language (and the specific country, if defined).
+   */
+  title: string;
+};

src/index.ts

@@ -16,6 +16,7 @@ export type {
   LocationDefinitions as AddressDefinitions,
   LocationDefinitions,
   LoremDefinitions,
+  MetadataDefinitions,
   MusicDefinitions,
   /** @deprecated Use PersonDefinitions instead */
   PersonDefinitions as NameDefinitions,

src/locales/af_ZA/index.ts

@@ -7,15 +7,16 @@ import cell_phone from './cell_phone';
 import company from './company';
 import internet from './internet';
 import location from './location';
+import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
 const af_ZA: LocaleDefinition = {
-  title: 'Afrikaans',
   cell_phone,
   company,
   internet,
   location,
+  metadata,
   person,
   phone_number,
 };

src/locales/af_ZA/metadata/index.ts

@@ -0,0 +1,12 @@
+/*
+ * This file is automatically generated.
+ * Run 'pnpm run generate:locales' to update.
+ */
+import type { MetadataDefinitions } from '../../..';
+import title from './title';
+
+const metadata: MetadataDefinitions = {
+  title,
+};
+
+export default metadata;

src/locales/af_ZA/metadata/title.ts

@@ -0,0 +1 @@
+export default 'Afrikaans';

src/locales/ar/index.ts

@@ -8,18 +8,19 @@ import color from './color';
 import commerce from './commerce';
 import date from './date';
 import location from './location';
+import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 import team from './team';
 import vehicle from './vehicle';
 
 const ar: LocaleDefinition = {
-  title: 'Arabic',
   cell_phone,
   color,
   commerce,
   date,
   location,
+  metadata,
   person,
   phone_number,
   team,

src/locales/ar/metadata/index.ts

@@ -0,0 +1,12 @@
+/*
+ * This file is automatically generated.
+ * Run 'pnpm run generate:locales' to update.
+ */
+import type { MetadataDefinitions } from '../../..';
+import title from './title';
+
+const metadata: MetadataDefinitions = {
+  title,
+};
+
+export default metadata;

src/locales/ar/metadata/title.ts

@@ -0,0 +1 @@
+export default 'Arabic';

src/locales/az/index.ts

@@ -9,17 +9,18 @@ import company from './company';
 import date from './date';
 import internet from './internet';
 import location from './location';
+import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
 const az: LocaleDefinition = {
-  title: 'Azerbaijani',
   color,
   commerce,
   company,
   date,
   internet,
   location,
+  metadata,
   person,
   phone_number,
 };

src/locales/az/metadata/index.ts

@@ -0,0 +1,12 @@
+/*
+ * This file is automatically generated.
+ * Run 'pnpm run generate:locales' to update.
+ */
+import type { MetadataDefinitions } from '../../..';
+import title from './title';
+
+const metadata: MetadataDefinitions = {
+  title,
+};
+
+export default metadata;

src/locales/az/metadata/title.ts

@@ -0,0 +1 @@
+export default 'Azerbaijani';

src/locales/cz/index.ts

@@ -8,16 +8,17 @@ import date from './date';
 import internet from './internet';
 import location from './location';
 import lorem from './lorem';
+import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 
 const cz: LocaleDefinition = {
-  title: 'Czech',
   company,
   date,
   internet,
   location,
   lorem,
+  metadata,
   person,
   phone_number,
 };

src/locales/cz/metadata/index.ts

@@ -0,0 +1,12 @@
+/*
+ * This file is automatically generated.
+ * Run 'pnpm run generate:locales' to update.
+ */
+import type { MetadataDefinitions } from '../../..';
+import title from './title';
+
+const metadata: MetadataDefinitions = {
+  title,
+};
+
+export default metadata;

src/locales/cz/metadata/title.ts

@@ -0,0 +1 @@
+export default 'Czech';

src/locales/de/index.ts

@@ -9,18 +9,19 @@ import date from './date';
 import internet from './internet';
 import location from './location';
 import lorem from './lorem';
+import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 import word from './word';
 
 const de: LocaleDefinition = {
-  title: 'German',
   cell_phone,
   company,
   date,
   internet,
   location,
   lorem,
+  metadata,
   person,
   phone_number,
   word,

src/locales/de/metadata/index.ts

@@ -0,0 +1,12 @@
+/*
+ * This file is automatically generated.
+ * Run 'pnpm run generate:locales' to update.
+ */
+import type { MetadataDefinitions } from '../../..';
+import title from './title';
+
+const metadata: MetadataDefinitions = {
+  title,
+};
+
+export default metadata;

src/locales/de/metadata/title.ts

@@ -0,0 +1 @@
+export default 'German';

src/locales/de_AT/index.ts

@@ -7,16 +7,17 @@ import cell_phone from './cell_phone';
 import company from './company';
 import internet from './internet';
 import location from './location';
+import metadata from './metadata';
 import person from './person';
 import phone_number from './phone_number';
 import word from './word';
 
 const de_AT: LocaleDefinition = {
-  title: 'German (Austria)',
   cell_phone,
   company,
   internet,
   location,
+  metadata,
   person,
   phone_number,
   word,

src/locales/de_AT/metadata/index.ts

@@ -0,0 +1,12 @@
+/*
+ * This file is automatically generated.
+ * Run 'pnpm run generate:locales' to update.
+ */
+import type { MetadataDefinitions } from '../../..';
+import title from './title';
+
+const metadata: MetadataDefinitions = {
+  title,
+};
+
+export default metadata;

src/locales/de_AT/metadata/title.ts

@@ -0,0 +1 @@
+export default 'German (Austria)';