refactor(location)!: rename definition street to street_pattern

[Shinigami92]

close #2020

[Shinigami92]

1. Is this a breaking change? Do we need to add the ! in PR title?
2. How should I name this PR/changelog entry?
3. What do we need to do for documentation?

[codecov]

Codecov Report

❗ No coverage uploaded for pull request base (next@14a033a). Click here to learn what that means.
The diff coverage is n/a.

❗ Current head ad6a9b1 differs from pull request most recent head 2ad2d86. Consider uploading reports for the commit 2ad2d86 to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##             next    #2051   +/-   ##
=======================================
  Coverage        ?   99.61%           
=======================================
  Files           ?     2536           
  Lines           ?   242236           
  Branches        ?     1298           
=======================================
  Hits            ?   241307           
  Misses          ?      902           
  Partials        ?       27           

[Shinigami92]

1. Is this a breaking change? Do we need to add the ! in PR title?

We decided yes, just to have this at the top in the changelog

2. How should I name this PR/changelog entry?

Still unsure how to name this
Especially the internal stuff is not really relevant

3. What do we need to do for documentation?

No response yet

[ST-DDT]

If I checked correctly the following locales have street_names, but no pattern using it.

• az
• es_MX
• he
• ka_GE
• ko
• lv
• nb_NO
• ro
• ru
• sv
• uk

I will create a new issue for this: #2062

[matthewmayer]

why is this marked as breaking in the PR desc?

[ST-DDT]

Because it breaks your code if you use fake("{{location.street}}").

[matthewmayer]

Won't {{location.street}} grab the method not the definitions?

[Shinigami92]

Won't {{location.street}} grab the method not the definitions?

I expect yes

please review or test what you need

[matthewmayer]

Looks ok but shouldn't be marked breaking if it isn't.

[matthewmayer]

On https://next.fakerjs.dev/guide/upgrading.html#faker-address-changed-to-faker-location perhaps the row for streetName should be updated to reflect that if you are upgrading from faker.address.streetName then you should migrate straight to faker.location.street instead of faker.location.streetName?

[ST-DDT]

Should we split this PR into two?
Both changes are indepent from each other.
#2070 (comment)

[xDivisionByZerox]

Should we split this PR into two? Both changes are indepent from each other. #2070 (comment)

Would be a welcome change but not required since we already reviewed it IMO

[ST-DDT]

Would be a welcome change but not required since we already reviewed it IMO

The migration guide needs updating anyway so it doesnt really matter IMO.

migration guide needs updating

[Shinigami92]

#2071 should be merged first, so this can be rebased