refactor(company): rename companyName to name

[Minozzzi]

Hi guys, I applied te deprecated workflow on function company.companyName(). And I have a suggestion to the new function created, the parameters could be an object instead array positions. What do you guys think?

Related issue: #1142

[Shinigami92]

We are already really slowly migrate nearly all functions to using an options object as parameter, so yes 🙂

[ST-DDT]

Instead of just copying the method you should call the new method from the old one.

[ejcheng]

Hmm, deprecation tests are failing...👀

I'm not too familiar with how those tests work, does anyone have any idea why it failed?

[ST-DDT]

FAIL test/scripts/apidoc/examplesAndDeprecations.spec.ts > examples and deprecations > Finance > transactionDescription
AssertionError: expected "warn" to not be called at allexpected "warn" to not be called at all
Received:
1st warn call:
Array [
"[@faker-js/faker]: faker.company.companyName() is deprecated. Please use faker.company.name() instead..",
]

It looks like finance.transactionDescription still calls company.companyName.

faker/src/modules/finance/index.ts

Line 427 in 05712b0

const company = this.faker.company.companyName();

Found missing deprecation properties.

[Minozzzi]

FAIL test/scripts/apidoc/examplesAndDeprecations.spec.ts > examples and deprecations > Finance > transactionDescription
AssertionError: expected "warn" to not be called at allexpected "warn" to not be called at all
Received:
1st warn call:
Array [
"[@faker-js/faker]: faker.company.companyName() is deprecated. Please use faker.company.name() instead..",
]

It looks like finance.transactionDescription still calls company.companyName.

faker/src/modules/finance/index.ts

Line 427 in 05712b0

const company = this.faker.company.companyName();

We should call company.name() on this module?

[xDivisionByZerox]

Yes, our functions should always call the latest faker functions.

[Minozzzi]

Corrected your comments 😁

[codecov]

Codecov Report

Merging #1166 (32b30d6) into main (fbddaa3) will decrease coverage by 0.00%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #1166      +/-   ##
==========================================
- Coverage   99.64%   99.64%   -0.01%     
==========================================
  Files        2146     2146              
  Lines      230467   230491      +24     
  Branches      980      980              
==========================================
+ Hits       229657   229678      +21     
- Misses        789      792       +3     
  Partials       21       21              

Impacted Files	Coverage Δ
src/modules/company/index.ts	100.00% <100.00%> (ø)
src/modules/finance/index.ts	99.31% <100.00%> (-0.69%)	⬇️