chore: convert to esm

[Shinigami92]

Convert the whole faker code base to ESM

[matthewmayer]

What are the benefits of this?

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (db88a15) 99.56% compared to head (1531c25) 99.55%.

Additional details and impacted files

@@            Coverage Diff             @@
##             next    #2261      +/-   ##
==========================================
- Coverage   99.56%   99.55%   -0.01%     
==========================================
  Files        2817     2817              
  Lines      251199   251199              
  Branches     1127     1125       -2     
==========================================
- Hits       250100   250088      -12     
+ Misses       1099     1082      -17     
- Partials        0       29      +29     

see 30 files with indirect coverage changes

[Shinigami92]

What are the benefits of this?

support for future features, top-level await in jsdoc generation scripts, enhance speed of disk access, and more

It's a try for #2260 (comment)

[Shinigami92]

After already sinking in around 5 hours of net time, I will give this a last chance today (when I find the time)

I read an article about placing package.json files into the dist/esm and dist/cjs folders that have separate configured "type" fields.
That way the cjs folder would read resolved .js files as cjs instead of esm

If that does not work, I will give up for now and we might even consider to release a @faker-js/faker together with a @faker-js/faker-cjs 🤷
This would even come with some advantages like we can see in the weekly download stats how necessary the cjs version even is and also reduce the unpacked size of each version into half/half

[Shinigami92]

Putting a package.json with { "type": "commonjs" } doesn't work, as not the package.json from the source, but the one next to dist is relevant

[Shinigami92]

awaiting merge of #2391

[Shinigami92]

There are errors 😕
I ran out of time right now, need to look for them later

[ST-DDT]

Looks like you have to change how https://github.com/faker-js/faker/blob/next/.github/workflows/commentCodeGeneration.ts is converted to js.
(Or run it using tsx instead?)

[ST-DDT]

I assume the issue is more in the calling of the file:

faker/.github/workflows/pr.yml

Line 59 in db88a15

const script = require('${{ github.workspace }}/.github/workflows/commentCodeGeneration.js')