chore: deprecate cityPrefix and citySuffix (#1041)

14 files changed, 72 insertions, 52 deletions

diff --git a/src/locales/af_ZA/address/city.ts b/src/locales/af_ZA/address/city.ts
index 757d4d0e..95588a58 100644
--- a/src/locales/af_ZA/address/city.ts
+++ b/src/locales/af_ZA/address/city.ts
@@ -1,6 +1,6 @@
 export default [
-  '{{address.cityPrefix}} {{name.firstName}}{{address.citySuffix}}',
-  '{{address.cityPrefix}} {{name.firstName}}',
-  '{{name.firstName}}{{address.citySuffix}}',
-  '{{name.lastName}}{{address.citySuffix}}',
+  '{{address.city_prefix}} {{name.firstName}}{{address.city_suffix}}',
+  '{{address.city_prefix}} {{name.firstName}}',
+  '{{name.firstName}}{{address.city_suffix}}',
+  '{{name.lastName}}{{address.city_suffix}}',
 ];
diff --git a/src/locales/el/address/city.ts b/src/locales/el/address/city.ts
index 757d4d0e..95588a58 100644
--- a/src/locales/el/address/city.ts
+++ b/src/locales/el/address/city.ts
@@ -1,6 +1,6 @@
 export default [
-  '{{address.cityPrefix}} {{name.firstName}}{{address.citySuffix}}',
-  '{{address.cityPrefix}} {{name.firstName}}',
-  '{{name.firstName}}{{address.citySuffix}}',
-  '{{name.lastName}}{{address.citySuffix}}',
+  '{{address.city_prefix}} {{name.firstName}}{{address.city_suffix}}',
+  '{{address.city_prefix}} {{name.firstName}}',
+  '{{name.firstName}}{{address.city_suffix}}',
+  '{{name.lastName}}{{address.city_suffix}}',
 ];
diff --git a/src/locales/en_AU/address/city.ts b/src/locales/en_AU/address/city.ts
index 757d4d0e..95588a58 100644
--- a/src/locales/en_AU/address/city.ts
+++ b/src/locales/en_AU/address/city.ts
@@ -1,6 +1,6 @@
 export default [
-  '{{address.cityPrefix}} {{name.firstName}}{{address.citySuffix}}',
-  '{{address.cityPrefix}} {{name.firstName}}',
-  '{{name.firstName}}{{address.citySuffix}}',
-  '{{name.lastName}}{{address.citySuffix}}',
+  '{{address.city_prefix}} {{name.firstName}}{{address.city_suffix}}',
+  '{{address.city_prefix}} {{name.firstName}}',
+  '{{name.firstName}}{{address.city_suffix}}',
+  '{{name.lastName}}{{address.city_suffix}}',
 ];
diff --git a/src/locales/en_CA/address/city.ts b/src/locales/en_CA/address/city.ts
index 757d4d0e..95588a58 100644
--- a/src/locales/en_CA/address/city.ts
+++ b/src/locales/en_CA/address/city.ts
@@ -1,6 +1,6 @@
 export default [
-  '{{address.cityPrefix}} {{name.firstName}}{{address.citySuffix}}',
-  '{{address.cityPrefix}} {{name.firstName}}',
-  '{{name.firstName}}{{address.citySuffix}}',
-  '{{name.lastName}}{{address.citySuffix}}',
+  '{{address.city_prefix}} {{name.firstName}}{{address.city_suffix}}',
+  '{{address.city_prefix}} {{name.firstName}}',
+  '{{name.firstName}}{{address.city_suffix}}',
+  '{{name.lastName}}{{address.city_suffix}}',
 ];
diff --git a/src/locales/en_GB/address/city.ts b/src/locales/en_GB/address/city.ts
index 757d4d0e..95588a58 100644
--- a/src/locales/en_GB/address/city.ts
+++ b/src/locales/en_GB/address/city.ts
@@ -1,6 +1,6 @@
 export default [
-  '{{address.cityPrefix}} {{name.firstName}}{{address.citySuffix}}',
-  '{{address.cityPrefix}} {{name.firstName}}',
-  '{{name.firstName}}{{address.citySuffix}}',
-  '{{name.lastName}}{{address.citySuffix}}',
+  '{{address.city_prefix}} {{name.firstName}}{{address.city_suffix}}',
+  '{{address.city_prefix}} {{name.firstName}}',
+  '{{name.firstName}}{{address.city_suffix}}',
+  '{{name.lastName}}{{address.city_suffix}}',
 ];
diff --git a/src/locales/en_IE/address/city.ts b/src/locales/en_IE/address/city.ts
index 757d4d0e..95588a58 100644
--- a/src/locales/en_IE/address/city.ts
+++ b/src/locales/en_IE/address/city.ts
@@ -1,6 +1,6 @@
 export default [
-  '{{address.cityPrefix}} {{name.firstName}}{{address.citySuffix}}',
-  '{{address.cityPrefix}} {{name.firstName}}',
-  '{{name.firstName}}{{address.citySuffix}}',
-  '{{name.lastName}}{{address.citySuffix}}',
+  '{{address.city_prefix}} {{name.firstName}}{{address.city_suffix}}',
+  '{{address.city_prefix}} {{name.firstName}}',
+  '{{name.firstName}}{{address.city_suffix}}',
+  '{{name.lastName}}{{address.city_suffix}}',
 ];
diff --git a/src/locales/en_US/address/city.ts b/src/locales/en_US/address/city.ts
index 757d4d0e..95588a58 100644
--- a/src/locales/en_US/address/city.ts
+++ b/src/locales/en_US/address/city.ts
@@ -1,6 +1,6 @@
 export default [
-  '{{address.cityPrefix}} {{name.firstName}}{{address.citySuffix}}',
-  '{{address.cityPrefix}} {{name.firstName}}',
-  '{{name.firstName}}{{address.citySuffix}}',
-  '{{name.lastName}}{{address.citySuffix}}',
+  '{{address.city_prefix}} {{name.firstName}}{{address.city_suffix}}',
+  '{{address.city_prefix}} {{name.firstName}}',
+  '{{name.firstName}}{{address.city_suffix}}',
+  '{{name.lastName}}{{address.city_suffix}}',
 ];
diff --git a/src/locales/fr_CA/address/city.ts b/src/locales/fr_CA/address/city.ts
index 757d4d0e..95588a58 100644
--- a/src/locales/fr_CA/address/city.ts
+++ b/src/locales/fr_CA/address/city.ts
@@ -1,6 +1,6 @@
 export default [
-  '{{address.cityPrefix}} {{name.firstName}}{{address.citySuffix}}',
-  '{{address.cityPrefix}} {{name.firstName}}',
-  '{{name.firstName}}{{address.citySuffix}}',
-  '{{name.lastName}}{{address.citySuffix}}',
+  '{{address.city_prefix}} {{name.firstName}}{{address.city_suffix}}',
+  '{{address.city_prefix}} {{name.firstName}}',
+  '{{name.firstName}}{{address.city_suffix}}',
+  '{{name.lastName}}{{address.city_suffix}}',
 ];
diff --git a/src/locales/ne/address/city.ts b/src/locales/ne/address/city.ts
index d869d1e9..86ea14b2 100644
--- a/src/locales/ne/address/city.ts
+++ b/src/locales/ne/address/city.ts
@@ -1,7 +1,7 @@
 export default [
-  '{{address.cityPrefix}} {{name.firstName}}{{address.citySuffix}}',
-  '{{address.cityPrefix}} {{name.firstName}}',
-  '{{name.firstName}}{{address.citySuffix}}',
-  '{{name.lastName}}{{address.citySuffix}}',
+  '{{address.city_prefix}} {{name.firstName}}{{address.city_suffix}}',
+  '{{address.city_prefix}} {{name.firstName}}',
+  '{{name.firstName}}{{address.city_suffix}}',
+  '{{name.lastName}}{{address.city_suffix}}',
   '{{address.city_name}}',
 ];
diff --git a/src/locales/pt_BR/address/city.ts b/src/locales/pt_BR/address/city.ts
index 757d4d0e..95588a58 100644
--- a/src/locales/pt_BR/address/city.ts
+++ b/src/locales/pt_BR/address/city.ts
@@ -1,6 +1,6 @@
 export default [
-  '{{address.cityPrefix}} {{name.firstName}}{{address.citySuffix}}',
-  '{{address.cityPrefix}} {{name.firstName}}',
-  '{{name.firstName}}{{address.citySuffix}}',
-  '{{name.lastName}}{{address.citySuffix}}',
+  '{{address.city_prefix}} {{name.firstName}}{{address.city_suffix}}',
+  '{{address.city_prefix}} {{name.firstName}}',
+  '{{name.firstName}}{{address.city_suffix}}',
+  '{{name.lastName}}{{address.city_suffix}}',
 ];
diff --git a/src/locales/ro/address/city.ts b/src/locales/ro/address/city.ts
index d869d1e9..86ea14b2 100644
--- a/src/locales/ro/address/city.ts
+++ b/src/locales/ro/address/city.ts
@@ -1,7 +1,7 @@
 export default [
-  '{{address.cityPrefix}} {{name.firstName}}{{address.citySuffix}}',
-  '{{address.cityPrefix}} {{name.firstName}}',
-  '{{name.firstName}}{{address.citySuffix}}',
-  '{{name.lastName}}{{address.citySuffix}}',
+  '{{address.city_prefix}} {{name.firstName}}{{address.city_suffix}}',
+  '{{address.city_prefix}} {{name.firstName}}',
+  '{{name.firstName}}{{address.city_suffix}}',
+  '{{name.lastName}}{{address.city_suffix}}',
   '{{address.city_name}}',
 ];
diff --git a/src/locales/tr/address/city.ts b/src/locales/tr/address/city.ts
index d869d1e9..86ea14b2 100644
--- a/src/locales/tr/address/city.ts
+++ b/src/locales/tr/address/city.ts
@@ -1,7 +1,7 @@
 export default [
-  '{{address.cityPrefix}} {{name.firstName}}{{address.citySuffix}}',
-  '{{address.cityPrefix}} {{name.firstName}}',
-  '{{name.firstName}}{{address.citySuffix}}',
-  '{{name.lastName}}{{address.citySuffix}}',
+  '{{address.city_prefix}} {{name.firstName}}{{address.city_suffix}}',
+  '{{address.city_prefix}} {{name.firstName}}',
+  '{{name.firstName}}{{address.city_suffix}}',
+  '{{name.lastName}}{{address.city_suffix}}',
   '{{address.city_name}}',
 ];
diff --git a/src/locales/zu_ZA/address/city.ts b/src/locales/zu_ZA/address/city.ts
index 757d4d0e..95588a58 100644
--- a/src/locales/zu_ZA/address/city.ts
+++ b/src/locales/zu_ZA/address/city.ts
@@ -1,6 +1,6 @@
 export default [
-  '{{address.cityPrefix}} {{name.firstName}}{{address.citySuffix}}',
-  '{{address.cityPrefix}} {{name.firstName}}',
-  '{{name.firstName}}{{address.citySuffix}}',
-  '{{name.lastName}}{{address.citySuffix}}',
+  '{{address.city_prefix}} {{name.firstName}}{{address.city_suffix}}',
+  '{{address.city_prefix}} {{name.firstName}}',
+  '{{name.firstName}}{{address.city_suffix}}',
+  '{{name.lastName}}{{address.city_suffix}}',
 ];
diff --git a/src/modules/address/index.ts b/src/modules/address/index.ts
index 311138a5..e3c568fd 100644
--- a/src/modules/address/index.ts
+++ b/src/modules/address/index.ts
@@ -92,10 +92,20 @@ export class Address {
   /**
    * Returns a random localized city prefix.
    *
+   * @see faker.address.city
+   *
    * @example
    * faker.address.cityPrefix() // 'East'
+   *
+   * @deprecated
    */
   cityPrefix(): string {
+    deprecated({
+      deprecated: 'faker.address.cityPrefix()',
+      proposed: "faker.address.city() or faker.fake('{{address.city_prefix}}')",
+      since: 'v7.2',
+      until: 'v8.0',
+    });
     return this.faker.helpers.arrayElement(
       this.faker.definitions.address.city_prefix
     );
@@ -104,10 +114,20 @@ export class Address {
   /**
    * Returns a random localized city suffix.
    *
+   * @see faker.address.city
+   *
    * @example
    * faker.address.citySuffix() // 'mouth'
+   *
+   * @deprecated
    */
   citySuffix(): string {
+    deprecated({
+      deprecated: 'faker.address.citySuffix()',
+      proposed: "faker.address.city() or faker.fake('{{address.city_suffix}}')",
+      since: 'v7.2',
+      until: 'v8.0',
+    });
     return this.faker.helpers.arrayElement(
       this.faker.definitions.address.city_suffix
     );