refactor(fake): move to helpers

[xDivisionByZerox]

This PR moves the fake() method from the Fake module into the Helpers module. The reason is, that there is no reason for it being a standalone module when it is clearly a utility method.

This was also discussed in #805 (direct link).

[codecov]

Codecov Report

Merging #1161 (eda6569) into main (09df73a) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main    #1161   +/-   ##
=======================================
  Coverage   99.62%   99.62%           
=======================================
  Files        2152     2152           
  Lines      236234   236291   +57     
  Branches      973      976    +3     
=======================================
+ Hits       235344   235411   +67     
+ Misses        869      859   -10     
  Partials       21       21           

Impacted Files	Coverage Δ
src/modules/address/index.ts	99.80% <100.00%> (ø)
src/modules/company/index.ts	100.00% <100.00%> (ø)
src/modules/fake/index.ts	100.00% <100.00%> (ø)
src/modules/helpers/index.ts	98.29% <100.00%> (+0.48%)	⬆️
src/modules/finance/index.ts	100.00% <0.00%> (+0.68%)	⬆️
src/modules/internet/user-agent.ts	83.59% <0.00%> (+1.85%)	⬆️

[Shinigami92]

Also just add a deprecation JSDoc Tag to the module + its constructor

Did you also update references in docs and readme?

[xDivisionByZerox]

Did you also update references in docs and readme?

Nah, I didn't check for that. Good catch. I really have to stop ONLY using the find all references feature^^

[xDivisionByZerox]

Also just add a deprecation JSDoc Tag to the module + its constructor

This is not possible since this would log a warning on Faker instance creation, which violates one of our test suites. I mean I can still add a JSDoc with a @deprecated parameter, but no deprecated function call in constructor.

[Shinigami92]

Also just add a deprecation JSDoc Tag to the module + its constructor

This is not possible since this would log a warning on Faker instance creation, which violates one of our test suites. I mean I can still add a JSDoc with a @deprecated parameter, but no deprecated function call in constructor.

Good catch, that's true

[xDivisionByZerox]

We had 4 individual approvals and this is non blocking. I think we can merge this.

[ST-DDT]

The tests seem to fail.

[xDivisionByZerox]

That's odd, but I'll have a look.

[xDivisionByZerox]

The tests seem to fail.

It was a missing test with the new test factory. @ST-DDT can you have a look if I've done this the right way?

[Shinigami92]

The implementation is approved, but I think this PR needs a rebase as it is older than the test overhaul, is it?

[ST-DDT]

but I think this PR needs a rebase as it is older than the test overhaul, is it?

It has been updated since.