Merge pull request #1 from faker-js/pr/matthewmayer/2025-suggestions/…

…st-ddt feat(locale): add additional metadata properties
faker-js · Apr 5, 2023 · a3af163 · a3af163
2 parents 497ff9f + 9ec1381
commit a3af163
Show file tree

Hide file tree

Showing 64 changed files with 157 additions and 135 deletions.
diff --git a/src/definitions/definitions.ts b/src/definitions/definitions.ts
@@ -32,7 +32,7 @@ export type LocaleEntry<T extends Record<string, unknown>> = Partial<T> &
  * that most properties are optional and extra properties are allowed.
  */
 export type LocaleDefinition = {
-  metadata: MetadataDefinitions;
+  metadata?: MetadataDefinitions;
   airline?: AirlineDefinitions;
   animal?: AnimalDefinitions;
   color?: ColorDefinitions;

diff --git a/src/definitions/metadata.ts b/src/definitions/metadata.ts
@@ -1,38 +1,60 @@
-export type MetadataDefinitions = {
+import type { LocaleEntry } from './definitions';
+
+/**
+ * Metadata for pre-built locales.
+ */
+export type PreBuiltMetadataDefinitions = {
   /**
    * The English name of the language (and the specific country, if defined).
    */
   title: string;
   /**
    * The full code of the locale, including the country code if applicable.
    */
-  code?: string;
+  code: string;
   /**
    * The endonym (native name) of the language (and the specific country, if defined).
    *
    * @see https://en.wikipedia.org/wiki/List_of_countries_and_dependencies_and_their_capitals_in_native_languages
    */
-  endonym?: string;
+  endonym: string;
   /**
    * The ISO 639-1 code of the language.
    *
    * @see https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
    */
-  language?: string;
+  language: string;
   /**
-   * The ISO 3166-1 alpha-2 code of the country.
-   *
-   * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
+   * The specific variant of the language. This usually refers to a dialect or slang.
    */
-  country?: string;
+  variant?: string;
   /**
    * Whether the language is written right-to-left.
    */
-  rtl?: boolean;
+  rtl: boolean;
   /**
    * The ISO 15924 code of the script.
    *
    * @see https://en.wikipedia.org/wiki/ISO_15924
    */
-  script?: string;
-} & Record<string, unknown>;
+  script: string;
+};
+
+/**
+ * Metadata for pre-built locales for a specific country.
+ */
+export type PreBuiltMetadataDefinitionsForCountry =
+  PreBuiltMetadataDefinitions & {
+    /**
+     * The ISO 3166-1 alpha-2 code of the country.
+     *
+     * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
+     */
+    country: string;
+  };
+
+/**
+ * Metadata for the current locale.
+ */
+export type MetadataDefinitions =
+  LocaleEntry<PreBuiltMetadataDefinitionsForCountry>;
diff --git a/src/locales/af_ZA/metadata.ts b/src/locales/af_ZA/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitionsForCountry } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitionsForCountry = {
   title: 'Afrikaans (South Africa)',
   code: 'af_ZA',
   country: 'ZA',

diff --git a/src/locales/ar/metadata.ts b/src/locales/ar/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitions } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitions = {
   title: 'Arabic',
   code: 'ar',
   language: 'ar',

diff --git a/src/locales/az/metadata.ts b/src/locales/az/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitions } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitions = {
   title: 'Azerbaijani',
   code: 'az',
   language: 'az',

diff --git a/src/locales/cs_CZ/metadata.ts b/src/locales/cs_CZ/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitionsForCountry } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitionsForCountry = {
   title: 'Czech (Czechia)',
   code: 'cs_CZ',
   country: 'CZ',

diff --git a/src/locales/de/metadata.ts b/src/locales/de/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitions } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitions = {
   title: 'German',
   code: 'de',
   language: 'de',

diff --git a/src/locales/de_AT/metadata.ts b/src/locales/de_AT/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitionsForCountry } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitionsForCountry = {
   title: 'German (Austria)',
   code: 'de_AT',
   country: 'AT',

diff --git a/src/locales/de_CH/metadata.ts b/src/locales/de_CH/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitionsForCountry } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitionsForCountry = {
   title: 'German (Switzerland)',
   code: 'de_CH',
   country: 'CH',

diff --git a/src/locales/dv/metadata.ts b/src/locales/dv/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitions } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitions = {
   title: 'Maldivian',
   code: 'dv',
   language: 'dv',

diff --git a/src/locales/el/metadata.ts b/src/locales/el/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitions } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitions = {
   title: 'Greek',
   code: 'el',
   language: 'el',

diff --git a/src/locales/en/metadata.ts b/src/locales/en/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitions } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitions = {
   title: 'English',
   code: 'en',
   language: 'en',

diff --git a/src/locales/en_AU/metadata.ts b/src/locales/en_AU/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitionsForCountry } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitionsForCountry = {
   title: 'English (Australia)',
   code: 'en_AU',
   country: 'AU',

diff --git a/src/locales/en_AU_ocker/metadata.ts b/src/locales/en_AU_ocker/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitionsForCountry } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitionsForCountry = {
   title: 'English (Australia Ocker)',
   code: 'en_AU_ocker',
   country: 'AU',

diff --git a/src/locales/en_BORK/metadata.ts b/src/locales/en_BORK/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitions } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitions = {
   title: 'English (Bork)',
   code: 'en_BORK',
   variant: 'BORK',

diff --git a/src/locales/en_CA/metadata.ts b/src/locales/en_CA/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitionsForCountry } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitionsForCountry = {
   title: 'English (Canada)',
   code: 'en_CA',
   country: 'CA',

diff --git a/src/locales/en_GB/metadata.ts b/src/locales/en_GB/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitionsForCountry } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitionsForCountry = {
   title: 'English (Great Britain)',
   code: 'en_GB',
   country: 'GB',

diff --git a/src/locales/en_GH/metadata.ts b/src/locales/en_GH/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitionsForCountry } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitionsForCountry = {
   title: 'English (Ghana)',
   code: 'en_GH',
   country: 'GH',

diff --git a/src/locales/en_IE/metadata.ts b/src/locales/en_IE/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitionsForCountry } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitionsForCountry = {
   title: 'English (Ireland)',
   code: 'en_IE',
   country: 'IE',

diff --git a/src/locales/en_IN/metadata.ts b/src/locales/en_IN/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitionsForCountry } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitionsForCountry = {
   title: 'English (India)',
   code: 'en_IN',
   country: 'IN',

diff --git a/src/locales/en_NG/metadata.ts b/src/locales/en_NG/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitionsForCountry } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitionsForCountry = {
   title: 'English (Nigeria)',
   code: 'en_NG',
   country: 'NG',

diff --git a/src/locales/en_US/metadata.ts b/src/locales/en_US/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitionsForCountry } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitionsForCountry = {
   title: 'English (United States)',
   code: 'en_US',
   country: 'US',

diff --git a/src/locales/en_ZA/metadata.ts b/src/locales/en_ZA/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitionsForCountry } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitionsForCountry = {
   title: 'English (South Africa)',
   code: 'en_ZA',
   country: 'ZA',

diff --git a/src/locales/es/metadata.ts b/src/locales/es/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitions } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitions = {
   title: 'Spanish',
   code: 'es',
   language: 'es',

diff --git a/src/locales/es_MX/metadata.ts b/src/locales/es_MX/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitionsForCountry } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitionsForCountry = {
   title: 'Spanish (Mexico)',
   code: 'es_MX',
   country: 'MX',

diff --git a/src/locales/fa/metadata.ts b/src/locales/fa/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitions } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitions = {
   title: 'Farsi/Persian',
   code: 'fa',
   language: 'fa',

diff --git a/src/locales/fi/metadata.ts b/src/locales/fi/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitions } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitions = {
   title: 'Finnish',
   code: 'fi',
   language: 'fi',

diff --git a/src/locales/fr/metadata.ts b/src/locales/fr/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitions } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitions = {
   title: 'French',
   code: 'fr',
   language: 'fr',

diff --git a/src/locales/fr_BE/metadata.ts b/src/locales/fr_BE/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitionsForCountry } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitionsForCountry = {
   title: 'French (Belgium)',
   code: 'fr_BE',
   country: 'BE',

diff --git a/src/locales/fr_CA/metadata.ts b/src/locales/fr_CA/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitionsForCountry } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitionsForCountry = {
   title: 'French (Canada)',
   code: 'fr_CA',
   country: 'CA',

diff --git a/src/locales/fr_CH/metadata.ts b/src/locales/fr_CH/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitionsForCountry } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitionsForCountry = {
   title: 'French (Switzerland)',
   code: 'fr_CH',
   country: 'CH',

diff --git a/src/locales/fr_LU/metadata.ts b/src/locales/fr_LU/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitionsForCountry } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitionsForCountry = {
   title: 'French (Luxembourg)',
   code: 'fr_LU',
   country: 'LU',

diff --git a/src/locales/he/metadata.ts b/src/locales/he/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitions } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitions = {
   title: 'Hebrew',
   code: 'he',
   language: 'he',

diff --git a/src/locales/hr/metadata.ts b/src/locales/hr/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitions } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitions = {
   title: 'Croatian',
   code: 'hr',
   language: 'hr',

diff --git a/src/locales/hu/metadata.ts b/src/locales/hu/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitions } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitions = {
   title: 'Hungarian',
   code: 'hu',
   language: 'hu',

diff --git a/src/locales/hy/metadata.ts b/src/locales/hy/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitions } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitions = {
   title: 'Armenian',
   code: 'hy',
   language: 'hy',

diff --git a/src/locales/id_ID/metadata.ts b/src/locales/id_ID/metadata.ts
@@ -1,6 +1,6 @@
-import type { MetadataDefinitions } from '../..';
+import type { PreBuiltMetadataDefinitionsForCountry } from '../../definitions/metadata';
 
-const metadata: MetadataDefinitions = {
+const metadata: PreBuiltMetadataDefinitionsForCountry = {
   title: 'Indonesian (Indonesia)',
   code: 'id_ID',
   country: 'ID',