feat: split SimpleFaker class from Faker

[Shinigami92]

references #1351

• Split the Faker class into smaller units #1351

[Shinigami92]

In DateModule we have a reference to definitions

https://github.com/faker-js/faker/pull/2369/files#diff-33d9552c7d1fb7f98cb50e15888b577d2609cd9b6f17a333b641752c5049629dR1001

I have multiple ideas how to solve this:

• Split a BaseDateModule from DateModule (theoretically we could do that with other modules as well)
• Add a check whether we are currently have definitions or not, if not the throw Error and indicate to use Faker instance instead
• open for alternative ideas

[xDivisionByZerox]

In DateModule we have a reference to definitions

#2369 (files)

I have multiple ideas how to solve this:

• Split a BaseDateModule from DateModule (theoretically we could do that with other modules as well)
• Add a check whether we are currently have definitions or not, if not the throw Error and indicate to use Faker instance instead
• open for alternative ideas

IMO we should simply exclude the date module from the BaseFaker class. Gernerally, if a module uses locale data, exclude it. If you want a Date you can still do new Date(faker.number.int({ ... })). I would take the easy route here.

[ST-DDT]

IMO Dates are very useful for everyday testing.

[Shinigami92]

Originally I just put it there because datatype uses date.between
But datatype is deprecated 👀

---

Well... datatype has boolean, that is needed for helpers... helpers has multiple and other nice to have stuff
it's like a waterfall, and all of that just because of month names in date module

[Shinigami92]

Okay... I tested building a BaseDateModule, but this is bad, because it produces faker.date conflicts between the BaseFaker and Faker class...

[codecov]

Codecov Report

Merging #2369 (0ace8eb) into next (f40e217) will decrease coverage by 0.01%.
The diff coverage is 100.00%.

Additional details and impacted files

@@            Coverage Diff             @@
##             next    #2369      +/-   ##
==========================================
- Coverage   99.61%   99.60%   -0.01%     
==========================================
  Files        2800     2801       +1     
  Lines      252410   252469      +59     
  Branches     1100     1103       +3     
==========================================
+ Hits       251435   251482      +47     
- Misses        948      960      +12     
  Partials       27       27              

Files Changed	Coverage Δ
src/faker.ts	88.23% <100.00%> (-3.83%)	⬇️
src/index.ts	100.00% <100.00%> (ø)
src/internal/bind-this-to-member-functions.ts	100.00% <100.00%> (ø)
src/modules/datatype/index.ts	100.00% <100.00%> (ø)
src/modules/date/index.ts	100.00% <100.00%> (ø)
src/modules/helpers/index.ts	99.12% <100.00%> (+<0.01%)	⬆️
src/modules/number/index.ts	100.00% <100.00%> (ø)
src/modules/string/index.ts	100.00% <100.00%> (ø)
src/simple-faker.ts	100.00% <100.00%> (ø)

... and 2 files with indirect coverage changes

[Shinigami92]

Potentially TODOs:

• add docs about baseFaker/BaseFaker
• add tests?!
• discuss if we want a @faker-js/faker/base
• export type Base*Module

[ST-DDT]

We are not sure about what the actual questions here are.

Team Decision

• add docs about baseFaker/BaseFaker

Yes

• add tests?!

Only tests that concern creating the base faker instance.

• discuss if we want a @faker-js/faker/base

Currently, we don't see a need for that, we should rather fix the tree-shaking.
Because if we add that now and remove it in v9 this will result in bad DX.

• export type Base*Module

Yes, only as types.

• Additionally

• Split BaseFaker+baseFaker into it's own file

[matthewmayer]

It would be good to document what the difference is between fakerBASE and BaseFaker in /guide/localization.html since they sound confusingly similar.

Stale change request