docs: rewrite tree-shaking part

[Shinigami92]

[codecov]

Codecov Report

Merging #549 (b24b0be) into main (4eef328) will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #549   +/-   ##
=======================================
  Coverage   99.34%   99.34%           
=======================================
  Files        1920     1920           
  Lines      176368   176368           
  Branches      904      906    +2     
=======================================
+ Hits       175211   175213    +2     
+ Misses       1101     1099    -2     
  Partials       56       56           

Impacted Files	Coverage Δ
src/vendor/unique.ts	97.58% <0.00%> (+1.61%)	⬆️

[JessicaSachs]

Content is good. Needs some rephrasing. Will check it out in a bit.

[JessicaSachs]

I'm following the instructions above. Do you expect

import { faker } from '@faker-js/faker

to be tree-shaken? I wrote this in my other comment, but nothing is tree-shakeable right now.

Steps to reproduce:

# clone faker
npm init vite
# (say yes to everything)
cd vite-project
pnpm install
cd ..
pnpm link --dir ./vite-project

Modify the JS to import faker.

// within main.js
import { faker } from '@faker-js/faker'
console.log(faker.locales) // shows all locales

Build and preview the dist for vite

pnpm vite build # See that the gzipped version is 678kb, should be ~200ish kb

If you modify the import to const fakerEn = require('@faker-js/faker/locale/en'), it's still not tree shaken and the bundle is ~600kb, even though faker.locales only shows that en is loaded.

We need to rewrite the docs to say that tree-shaking isn't supported right now, or we need to change the way we export the Faker class.

[Shinigami92]

@JessicaSachs 600kb seems really accurate, we really have that much for the english locales.
So using @faker-js/faker/locale/en "only" loads these english locales + the faker instance.
When using the full faker instance, it loads all locales that results in ~7mb ⚠️

[Shinigami92]

@JessicaSachs #548 will solve the tree-shaking problem for locale imports

[Shinigami92]

@JessicaSachs could you have a new look into this? Now that #548 is merged?

[Shinigami92]

Not sure how to proceed here and no response yet from @JessicaSachs 🤔
I think it's better then the current live documentation. So if we want to change something, we can open a commit in the future anyways 🤷

[JessicaSachs]

This is good! I'm sorry I hadn't checked back in. Some wording can be improved but it is good as-is.