feat(locale): add en_HK locale (#2083)

Author: matthewmayer

docs/guide/localization.md

@@ -91,6 +91,7 @@ In this example there are 5 locales. Each of these is checked in order, and the
 | `en_CA`       | English (Canada)          | `fakerEN_CA`       |
 | `en_GB`       | English (Great Britain)   | `fakerEN_GB`       |
 | `en_GH`       | English (Ghana)           | `fakerEN_GH`       |
+| `en_HK`       | English (Hong Kong)       | `fakerEN_HK`       |
 | `en_IE`       | English (Ireland)         | `fakerEN_IE`       |
 | `en_IN`       | English (India)           | `fakerEN_IN`       |
 | `en_NG`       | English (Nigeria)         | `fakerEN_NG`       |

docs/guide/upgrading.md

@@ -123,20 +123,12 @@ fakerES.music.songName(); // 'I Want to Hold Your Hand' (fallback from en)
 fakerES_noFallbacks.music.songName(); // throws a FakerError
 ```
 
-This also has an impact on data that aren't applicable to a locale, for example Chinese doesn't use prefixes in names.
+This also has an impact on data that aren't applicable to a locale, for example Hong Kong (`en_HK`) doesn't use ZIP codes/postcodes.
 
 ```ts
-import { faker, fakerZH_CN, zh_CN } from '@faker-js/faker';
-
-const fakerZH_CN_noFallbacks = new Faker({
-  locale: [zh_CN],
-});
-
-faker.name.prefix(); // 'Mr'
-// Previously:
-//fakerZH_CN_noFallbacks.person.prefix(); // undefined
-// Now:
-fakerZH_CN.person.prefix(); // throws a FakerError
+import { fakerEN_US, fakerEN_HK } from '@faker-js/faker';
+fakerEN_US.location.zipCode(); // 90210
+fakerEN_HK.location.zipCode(); // throws a FakerError
 ```
 
 ### `faker.mersenne` and `faker.helpers.repeatString` removed

src/locale/en_HK.ts

@@ -0,0 +1,13 @@
+/*
+ * This file is automatically generated.
+ * Run 'pnpm run generate:locales' to update.
+ */
+
+import { Faker } from '../faker';
+import base from '../locales/base';
+import en from '../locales/en';
+import en_HK from '../locales/en_HK';
+
+export const faker = new Faker({
+  locale: [en_HK, en, base],
+});

src/locale/index.ts

@@ -20,6 +20,7 @@ import { faker as fakerEN_BORK } from './en_BORK';
 import { faker as fakerEN_CA } from './en_CA';
 import { faker as fakerEN_GB } from './en_GB';
 import { faker as fakerEN_GH } from './en_GH';
+import { faker as fakerEN_HK } from './en_HK';
 import { faker as fakerEN_IE } from './en_IE';
 import { faker as fakerEN_IN } from './en_IN';
 import { faker as fakerEN_NG } from './en_NG';
@@ -84,6 +85,7 @@ export {
   fakerEN_CA,
   fakerEN_GB,
   fakerEN_GH,
+  fakerEN_HK,
   fakerEN_IE,
   fakerEN_IN,
   fakerEN_NG,
@@ -149,6 +151,7 @@ export const allFakers = {
   en_CA: fakerEN_CA,
   en_GB: fakerEN_GB,
   en_GH: fakerEN_GH,
+  en_HK: fakerEN_HK,
   en_IE: fakerEN_IE,
   en_IN: fakerEN_IN,
   en_NG: fakerEN_NG,

src/locales/en_HK/company/index.ts

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

src/locales/en_HK/company/suffix.ts

@@ -0,0 +1 @@
+export default ['Ltd.', 'Co. Ltd.'];

src/locales/en_HK/index.ts

@@ -0,0 +1,22 @@
+/*
+ * This file is automatically generated.
+ * Run 'pnpm run generate:locales' to update.
+ */
+import type { LocaleDefinition } from '../..';
+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 en_HK: LocaleDefinition = {
+  company,
+  internet,
+  location,
+  metadata,
+  person,
+  phone_number,
+};
+
+export default en_HK;

src/locales/en_HK/internet/domain_suffix.ts

@@ -0,0 +1 @@
+export default ['com', 'hk', 'com.hk', 'org.hk'];

src/locales/en_HK/internet/index.ts

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

src/locales/en_HK/location/building_number.ts

@@ -0,0 +1 @@
+export default ['###', '##', '#'];