docs: document supported locales

[fzn0x]

Clear and concise description of the problem

Document supported locales in https://github.com/faker-js/faker/tree/main/locale

Avoid related issues and discussions (e.g #209)

Suggested solution

Write supported locales in https://github.com/faker-js/faker/tree/main/locale

Alternative

Additional context

• Using table
• Add navigation to locale README in main README.

[github-actions]

Hello @fncolon. We like your proposal/feedback and would appreciate a contribution via a Pull Request by you or another community member. We thank you in advance for your contribution and are looking forward to reviewing it!

[Shinigami92]

We should do three things:

1. Add the supported locales in the VitePress docs
2. Add them in README.md (so that folks on the npm site can read it without the need of jump into docs but just searching with ctrl+f)
3. Add an enum/string literal that defines the locales and export it + type the functions in TS
   But maybe it's possible to provide you own locale on demand from external, so it might need to be an LiteralUnion (see e.g. Literal String Union Autocomplete microsoft/TypeScript#29729 (comment))

[Shinigami92]

Please also note that there is currently a huge PR that needs to be merged first, to reduce rebase/merge mess #169

[fzn0x]

We should do three things:

1. Add the supported locales in the VitePress docs
2. Add them in README.md (so that folks on the npm site can read it without the need of jump into docs but just searching with ctrl+f)
3. Add an enum/string literal that defines the locales and export it + type the functions in TS
   But maybe it's possible to provide you own locale on demand from external, so it might need to be an LiteralUnion (see e.g. Literal String Union Autocomplete microsoft/TypeScript#29729 (comment))

Cool! especially number 3

[fzn0x]

Please also note that there is currently a huge PR that needs to be merged first, to reduce rebase/merge mess #169

Noted, thanks @Shinigami92

[Shinigami92]

Update to my comment: #210 (comment)

We now already have: https://github.com/faker-js/faker#localization and https://fakerjs.dev/api/localization#localization
We don't have an automatisation for updating these.
Also I think we should link from the README.md to the official docs, so we don't need to keep the README.md up to date.

Also we want inline dev docs for the Faker constructor options.locale + LiteralUnion typed

[ST-DDT]

I would like to do this.

[ST-DDT]

This is covered completely by #248 (TS) and #252 (docs)