refactor(locale): use null as not applicable (#2078)

Author: ST-DDT

src/definitions/definitions.ts

@@ -22,9 +22,9 @@ import type { WordDefinitions } from './word';
 /**
  * Wrapper type for all definition categories that will make all properties optional and allow extra properties.
  */
-export type LocaleEntry<T extends Record<string, unknown>> = Partial<T> &
-  // Unsupported & custom entries
-  Record<string, unknown>;
+export type LocaleEntry<T extends Record<string, unknown>> = {
+  [P in keyof T]?: T[P] | null;
+} & Record<string, unknown>; // Unsupported & custom entries
 
 /**
  * The definitions as used by the translations/locales.

src/definitions/person.ts

@@ -7,21 +7,21 @@ export type PersonDefinitions = LocaleEntry<{
   gender: string[];
   sex: string[];
 
-  prefix?: string[];
-  female_prefix?: string[];
-  male_prefix?: string[];
+  prefix: string[];
+  female_prefix: string[];
+  male_prefix: string[];
 
-  first_name?: string[];
-  female_first_name?: string[];
-  male_first_name?: string[];
+  first_name: string[];
+  female_first_name: string[];
+  male_first_name: string[];
 
-  middle_name?: string[];
-  female_middle_name?: string[];
-  male_middle_name?: string[];
+  middle_name: string[];
+  female_middle_name: string[];
+  male_middle_name: string[];
 
-  last_name?: string[];
-  female_last_name?: string[];
-  male_last_name?: string[];
+  last_name: string[];
+  female_last_name: string[];
+  male_last_name: string[];
 
   suffix: string[];
 
@@ -33,11 +33,11 @@ export type PersonDefinitions = LocaleEntry<{
   /**
    * A weighted list of patterns used to generate last names.
    */
-  last_name_pattern?: Array<{ value: string; weight: number }>;
-  male_last_name_pattern?: Array<{ value: string; weight: number }>;
-  female_last_name_pattern?: Array<{ value: string; weight: number }>;
+  last_name_pattern: Array<{ value: string; weight: number }>;
+  male_last_name_pattern: Array<{ value: string; weight: number }>;
+  female_last_name_pattern: Array<{ value: string; weight: number }>;
 
-  bio_pattern?: string[];
+  bio_pattern: string[];
 
   title: PersonTitleDefinitions;
 
@@ -47,8 +47,8 @@ export type PersonDefinitions = LocaleEntry<{
 /**
  * The possible definitions related to people's titles.
  */
-export interface PersonTitleDefinitions {
-  descriptor?: string[];
+export type PersonTitleDefinitions = LocaleEntry<{
+  descriptor: string[];
   job: string[];
-  level?: string[];
-}
+  level: string[];
+}>;

src/locales/az/company/suffix.ts

@@ -1 +1 @@
-export default [];
+export default null;

src/locales/az/location/state.ts

@@ -1 +1 @@
-export default [];
+export default null;

src/locales/az/person/female_prefix.ts

@@ -1 +1 @@
-export default [];
+export default null;

src/locales/az/person/male_prefix.ts

@@ -1 +1 @@
-export default [];
+export default null;

src/locales/az/person/prefix.ts

@@ -1,5 +1 @@
-import { mergeArrays } from './../../../internal/merge';
-import female_prefix from './female_prefix';
-import male_prefix from './male_prefix';
-
-export default mergeArrays(female_prefix, male_prefix);
+export default null;

src/locales/az/person/suffix.ts

@@ -1 +1 @@
-export default [];
+export default null;

src/locales/id_ID/person/female_prefix.ts

@@ -1 +1 @@
-export default [];
+export default null;

src/locales/id_ID/person/male_prefix.ts

@@ -1 +1 @@
-export default [];
+export default null;

src/locales/id_ID/person/prefix.ts

@@ -1,5 +1 @@
-import { mergeArrays } from './../../../internal/merge';
-import female_prefix from './female_prefix';
-import male_prefix from './male_prefix';
-
-export default mergeArrays(female_prefix, male_prefix);
+export default null;

src/locales/it/person/suffix.ts

@@ -1 +1 @@
-export default [];
+export default null;

src/locales/mk/person/suffix.ts

@@ -1 +1 @@
-export default [];
+export default null;

src/locales/pt_BR/location/city_prefix.ts

@@ -1 +1 @@
-export default [];
+export default null;

src/locales/pt_PT/location/city_prefix.ts

@@ -1 +1 @@
-export default [];
+export default null;

src/locales/pt_PT/location/city_suffix.ts

@@ -1 +1 @@
-export default [];
+export default null;

src/locales/pt_PT/person/suffix.ts

@@ -1 +1 @@
-export default [];
+export default null;

src/locales/ru/person/female_prefix.ts

@@ -1 +1 @@
-export default [];
+export default null;

src/locales/ru/person/male_prefix.ts

@@ -1 +1 @@
-export default [];
+export default null;

src/locales/ru/person/prefix.ts

@@ -1,5 +1 @@
-import { mergeArrays } from './../../../internal/merge';
-import female_prefix from './female_prefix';
-import male_prefix from './male_prefix';
-
-export default mergeArrays(female_prefix, male_prefix);
+export default null;

src/locales/ru/person/suffix.ts

@@ -1 +1 @@
-export default [];
+export default null;

src/locales/sk/location/state.ts

@@ -1 +1 @@
-export default [];
+export default null;

src/locales/sk/location/state_abbr.ts

@@ -1 +1 @@
-export default [];
+export default null;

src/locales/th/location/city_prefix.ts

@@ -1 +1 @@
-export default [];
+export default null;

src/locales/th/location/city_suffix.ts

@@ -1 +1 @@
-export default [];
+export default null;

src/locales/zh_CN/person/female_prefix.ts

@@ -1 +1 @@
-export default [];
+export default null;

src/locales/zh_CN/person/male_prefix.ts

@@ -1 +1 @@
-export default [];
+export default null;

src/locales/zh_CN/person/prefix.ts

@@ -1,5 +1 @@
-import { mergeArrays } from './../../../internal/merge';
-import female_prefix from './female_prefix';
-import male_prefix from './male_prefix';
-
-export default mergeArrays(female_prefix, male_prefix);
+export default null;

src/locales/zh_TW/person/female_prefix.ts

@@ -1 +1 @@
-export default [];
+export default null;

src/locales/zh_TW/person/male_prefix.ts

@@ -1 +1 @@
-export default [];
+export default null;

src/locales/zh_TW/person/prefix.ts

@@ -1,5 +1 @@
-import { mergeArrays } from './../../../internal/merge';
-import female_prefix from './female_prefix';
-import male_prefix from './male_prefix';
-
-export default mergeArrays(female_prefix, male_prefix);
+export default null;

test/person.spec.ts

@@ -125,7 +125,7 @@ describe('person', () => {
             ...fakerMK.definitions.person.female_prefix,
             ...fakerMK.definitions.person.female_first_name,
             ...fakerMK.definitions.person.female_last_name,
-            ...fakerMK.definitions.person.suffix,
+            // ...fakerMK.definitions.person.suffix, // Not applicable
           ];
 
           const fullName = fakerMK.person.fullName({ sex: 'female' });
@@ -141,7 +141,7 @@ describe('person', () => {
             ...fakerMK.definitions.person.male_prefix,
             ...fakerMK.definitions.person.male_first_name,
             ...fakerMK.definitions.person.male_last_name,
-            ...fakerMK.definitions.person.suffix,
+            // ...fakerMK.definitions.person.suffix, // Not applicable
           ];
 
           const fullName = fakerMK.person.fullName({ sex: 'male' });
@@ -157,7 +157,7 @@ describe('person', () => {
             ...fakerMK.definitions.person.female_prefix,
             'firstName',
             'lastName',
-            ...fakerMK.definitions.person.suffix,
+            // ...fakerMK.definitions.person.suffix, // Not applicable
           ];
 
           const fullName = fakerMK.person.fullName({
@@ -177,7 +177,7 @@ describe('person', () => {
             ...fakerMK.definitions.person.male_prefix,
             'firstName',
             'lastName',
-            ...fakerMK.definitions.person.suffix,
+            //...fakerMK.definitions.person.suffix, // Not applicable
           ];
 
           const fullName = fakerMK.person.fullName({

test/utils/merge-locales.spec.ts

@@ -29,6 +29,38 @@ describe('mergeLocales', () => {
     });
   });
 
+  it('should not overwrite not applicable data', () => {
+    const locale1: LocaleDefinition = {
+      metadata: { title: 'a' },
+      location: {
+        city: null,
+        country: null,
+      },
+    };
+    const locale2: LocaleDefinition = {
+      metadata: { title: 'b' },
+      location: {
+        city: ['b'],
+      },
+    };
+    const locale3: LocaleDefinition = {
+      metadata: { title: 'c' },
+      location: {
+        city: ['c'],
+        country: ['c'],
+      },
+    };
+    const merged = mergeLocales([locale1, locale2, locale3]);
+
+    expect(merged).toEqual({
+      metadata: { title: 'a' },
+      location: {
+        city: null,
+        country: null,
+      },
+    });
+  });
+
   it('should extend categories', () => {
     const locale1: LocaleDefinition = {
       metadata: { title: 'a' },