refactor!: reorganize src folder

[Shinigami92]

No description provided.

[codecov]

Codecov Report

Merging #909 (e493433) into main (cc46a0c) will decrease coverage by 0.00%.
The diff coverage is 87.50%.

@@            Coverage Diff             @@
##             main     #909      +/-   ##
==========================================
- Coverage   99.13%   99.13%   -0.01%     
==========================================
  Files        1958     1958              
  Lines      210788   210793       +5     
  Branches      907      906       -1     
==========================================
- Hits       208971   208964       -7     
- Misses       1741     1753      +12     
  Partials       76       76              

Impacted Files	Coverage Δ
src/definitions/internet.ts	0.00% <0.00%> (ø)
src/modules/finance/iban.ts	100.00% <ø> (ø)
src/modules/mersenne/twister.ts	95.93% <ø> (ø)
src/utils/types.ts	0.00% <0.00%> (ø)
src/index.ts	97.50% <50.00%> (ø)
src/faker.ts	92.96% <100.00%> (-0.11%)	⬇️
src/modules/address/index.ts	99.79% <100.00%> (ø)
src/modules/animal/index.ts	100.00% <100.00%> (ø)
src/modules/commerce/index.ts	100.00% <100.00%> (ø)
src/modules/company/index.ts	100.00% <100.00%> (ø)
... and 28 more

[xDivisionByZerox]

While we at it: Should we provide a directory for each module? Like address.ts would be located in src/modules/address/address.ts (or index.ts). That would allow us to scope additional requirements for this module in this directory, for example image-providers in the modules/image directory.

[xDivisionByZerox]

While we at it: Should we provide a directory for each module? Like address.ts would be located in src/modules/address/address.ts (or index.ts). That would allow us to scope additional requirements for this module in this directory, for example image-providers in the modules/image directory.

This could be a bit overkill for most modules for now, but should give more reliability in the future (perhaps, IDK TBH) since files can be added more easily.

[ST-DDT]

I don't think we should do it for all modules, but maybe for all that would benefit from it?
AFAICT there isn't much difference between import from address.ts and address/index.ts so it should be save to update/change later on.

[xDivisionByZerox]

The difference would be that we would not lose file history again if we need to reorganize since all files are already in their own module directory.

[Shinigami92]

To be fair, I had the same idea as @xDivisionByZerox 🤔
Also maybe we would e.g. split every function into it's own file but let them in their "scopes" (in a far far away future)
It's just more future proof

[ST-DDT]

Please rename src/modules/mersenne/mersenne.ts to something like src/modules/mersenne/twister.ts to reduce some confusion.

[pkuczynski]

I use this pattern also at my work for a NestJS application. But if we want that, let's do it in a separate PR as it is not that important as the src files itself.

Sure! It should be done in a separate PR. I was just giving a rationale why its worth to have subfolders.

[xDivisionByZerox]

Do we need to change the test directory at all? Otherwise, the PR title could be confusing. So either revert the test changes from the current PR or change the title, please.

[ST-DDT]

Yeah, moving the tests twice is kind of redundant.
It is also kind of consistent to have a similar structure for both src and test, even though the tests will be moved again shortly.

[Shinigami92]

I extracted the test restructure into its own issue: #911