refactor!: only use FakerCore in modules

[ST-DDT]

Continuation of #3748

• feat: complete standalone modular functions transformation #3748

---

• Replace all references to Faker and SimpleFaker inside modules with FakerCore.
  • The HelpersModule is the only module, that retains a reference to Faker as it needs it for the module tree.
• The modules are now initialized inside the Faker constructor, as they require a reference to the FakerCore instance, that is passed as constructor parameter.
• This is breaking for JS users, that previously could access the Faker instances via faker.airline.faker.

[netlify]

✅ Deploy Preview for fakerjs ready!

Name	Link
🔨 Latest commit	a718c18
🔍 Latest deploy log	https://app.netlify.com/projects/fakerjs/deploys/6ab7a0ac6d93140008fa8544
😎 Deploy Preview	https://deploy-preview-4081.fakerjs.dev
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
🤖 Make changes	Run an agent on this branch

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.17%. Comparing base (b4b7305) to head (a718c18).

Additional details and impacted files

@@            Coverage Diff             @@
##             next    #4081      +/-   ##
==========================================
- Coverage   99.17%   99.17%   -0.01%     
==========================================
  Files        1172     1172              
  Lines        3888     3884       -4     
  Branches      693      693              
==========================================
- Hits         3856     3852       -4     
  Misses         28       28              
  Partials        4        4              

Files with missing lines	Coverage Δ
src/faker.ts	100.00% <100.00%> (ø)
src/internal/module-base.ts	100.00% <100.00%> (ø)
src/modules/airline/module.ts	100.00% <100.00%> (ø)
src/modules/animal/module.ts	100.00% <100.00%> (ø)
src/modules/book/module.ts	100.00% <100.00%> (ø)
src/modules/color/module.ts	100.00% <100.00%> (ø)
src/modules/commerce/module.ts	100.00% <100.00%> (ø)
src/modules/company/module.ts	100.00% <100.00%> (ø)
src/modules/database/module.ts	100.00% <100.00%> (ø)
src/modules/datatype/module.ts	100.00% <100.00%> (ø)
... and 21 more

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[Shinigami92]

I talked to my AI and we agree: this is an acceptable breaking change and would not affect an end-user. The only affected users by this breaking change are meta-framework contributors which extends for one of the abstract classes, but even then these are not made public through dist/index.ts and therefore would require a (theoretically not officially supported) deep import.

[xDivisionByZerox]

I talked to my AI and we agree: this is an acceptable breaking change and would not affect an end-user. The only affected users by this breaking change are meta-framework contributors which extends for one of the abstract classes, but even then these are not made public through dist/index.ts and therefore would require a (theoretically not officially supported) deep import.

It is a breaking change because the faker property has an access level of protected. Simply extending any module (or the module base) and accessing faker (which is normal to do prior to SMF) would now break.

const AirlineModuleCtor = faker.airline.constructor.prototype as { new (): AirlineModule }
class MyCustomAirlineModule extends AirlineModuleCtor {
  abc() {
    return this.faker.string.sample(); // error: faker is not defined
  }
}

[Shinigami92]

It is a breaking change because the faker property has an access level of protected. Simply extending any module (or the module base) and accessing faker (which is normal to do prior to SMF) would now break.

const AirlineModuleCtor = faker.airline.constructor.prototype as { new (): AirlineModule }
class MyCustomAirlineModule extends AirlineModuleCtor {
  abc() {
    return this.faker.string.sample(); // error: faker is not defined
  }
}

You don't even need to go that far, already myModule instanceof SimpleModuleBase is not possible anymore

[ST-DDT]

Should we write a migration guide for this?
If yes, what do we say in there. "Dear JS user, if you relied on an internal/non-api field field or constructor, then that is no longer possible/it has been renamed to fakerCore." (Just more polite)?

[Shinigami92]

Should we write a migration guide for this? If yes, what do we say in there. "Dear JS user, if you relied on an internal/non-api field field or constructor, then that is no longer possible/it has been renamed to fakerCore." (Just more polite)?

If @matthewmayer says no to that, I think we are safe to merge without a migration guide here.

[matthewmayer]

I'm ok with no migration guide for this change.