refactor(location): deprecate cityName (#2070)

Author: xDivisionByZerox

docs/guide/upgrading.md

@@ -167,7 +167,7 @@ The `faker.address.*` methods will continue to work as an alias in v8 and v9, bu
 | `faker.address.buildingNumber`      | `faker.location.buildingNumber`      |
 | `faker.address.cardinalDirection`   | `faker.location.cardinalDirection`   |
 | `faker.address.city`                | `faker.location.city`                |
-| `faker.address.cityName`            | `faker.location.cityName`            |
+| `faker.address.cityName`            | `faker.location.city`                |
 | `faker.address.country`             | `faker.location.country`             |
 | `faker.address.countryCode`         | `faker.location.countryCode`         |
 | `faker.address.county`              | `faker.location.county`              |

src/modules/location/index.ts

@@ -156,13 +156,23 @@ export class LocationModule {
   /**
    * Returns a random city name from a list of real cities for the locale.
    *
+   * @see faker.location.city()
+   *
    * @example
    * faker.location.cityName() // 'San Rafael'
    * fakerDE.location.cityName() // 'Nürnberg'
    *
    * @since 8.0.0
+   *
+   * @deprecated Use `faker.location.city()` instead.
    */
   cityName(): string {
+    deprecated({
+      deprecated: 'faker.location.cityName',
+      proposed: 'faker.location.city',
+      since: '8.0',
+      until: '9.0',
+    });
     return this.faker.helpers.arrayElement(
       this.faker.definitions.location.city_name
     );

src/modules/random/index.ts

@@ -53,7 +53,6 @@ export class RandomModule {
 
     const wordMethods = [
       () => this.faker.location.cardinalDirection(),
-      this.faker.location.cityName,
       this.faker.location.country,
       this.faker.location.county,
       () => this.faker.location.direction(),

test/__snapshots__/random.spec.ts.snap

@@ -12,13 +12,13 @@ exports[`random > 42 > numeric > noArgs 1`] = `"3"`;
 
 exports[`random > 42 > numeric > with length 1`] = `"37917"`;
 
-exports[`random > 42 > word 1`] = `"responsive"`;
+exports[`random > 42 > word 1`] = `"project"`;
 
-exports[`random > 42 > words > noArgs 1`] = `"lavender Shoes"`;
+exports[`random > 42 > words > noArgs 1`] = `"Hybrid Shoes"`;
 
-exports[`random > 42 > words > with length 1`] = `"responsive comics Neptunium Hip deposit"`;
+exports[`random > 42 > words > with length 1`] = `"project comics Neptunium Multigender violet"`;
 
-exports[`random > 42 > words > with length range 1`] = `"lavender Shoes"`;
+exports[`random > 42 > words > with length range 1`] = `"Hybrid Shoes"`;
 
 exports[`random > 1211 > alpha > noArgs 1`] = `"W"`;
 
@@ -34,11 +34,11 @@ exports[`random > 1211 > numeric > with length 1`] = `"94872"`;
 
 exports[`random > 1211 > word 1`] = `"gah"`;
 
-exports[`random > 1211 > words > noArgs 1`] = `"invoice Cyclocross assail"`;
+exports[`random > 1211 > words > noArgs 1`] = `"USB teal Batz"`;
 
-exports[`random > 1211 > words > with length 1`] = `"gah strictly Rustic assail Manager"`;
+exports[`random > 1211 > words > with length 1`] = `"gah strictly Bronze assail Manager"`;
 
-exports[`random > 1211 > words > with length range 1`] = `"invoice Cyclocross assail Manager Gourde"`;
+exports[`random > 1211 > words > with length range 1`] = `"USB teal Batz Manager male"`;
 
 exports[`random > 1337 > alpha > noArgs 1`] = `"n"`;
 
@@ -56,6 +56,6 @@ exports[`random > 1337 > word 1`] = `"Bespoke"`;
 
 exports[`random > 1337 > words > noArgs 1`] = `"quia"`;
 
-exports[`random > 1337 > words > with length 1`] = `"Bespoke connect Fort generating Ball"`;
+exports[`random > 1337 > words > with length 1`] = `"Bespoke connect French pixel Ball"`;
 
-exports[`random > 1337 > words > with length range 1`] = `"quia Ball"`;
+exports[`random > 1337 > words > with length range 1`] = `"quia Incredible"`;