Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: introduce locale proxy #2004

Merged
merged 46 commits into from
Apr 23, 2023
Merged
Changes from 1 commit
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
f688434
feat: introduce locale access proxy
ST-DDT Apr 1, 2023
9db8ff9
chore: fix typo
ST-DDT Apr 2, 2023
bef53d7
Merge branch 'next' into feat/locale-access-proxy
ST-DDT Apr 2, 2023
b495965
test: extend proxy tests
ST-DDT Apr 2, 2023
c0be7e1
chore: fix import order
ST-DDT Apr 2, 2023
109ef31
test: use describe instead of comment sections
ST-DDT Apr 2, 2023
0f42fda
chore: apply suggestions
ST-DDT Apr 2, 2023
8530492
Merge branch 'next' into feat/locale-access-proxy
ST-DDT Apr 2, 2023
149ec6b
Merge branch 'next' into feat/locale-access-proxy
ST-DDT Apr 2, 2023
eebccd0
docs: extend migration guide
ST-DDT Apr 2, 2023
5c70e32
chore: typo
ST-DDT Apr 2, 2023
5c73725
chore: reword
ST-DDT Apr 2, 2023
df38ac7
chore: mark string type
ST-DDT Apr 2, 2023
d8fa41f
docs: add examples
ST-DDT Apr 2, 2023
05d2cab
docs: improve example
ST-DDT Apr 2, 2023
79cb31a
docs: apply suggestions
ST-DDT Apr 2, 2023
885627b
chore: fix typo
ST-DDT Apr 2, 2023
0ff62af
chore: apply suggestion
ST-DDT Apr 2, 2023
42443fa
Merge branch 'next' into feat/locale-access-proxy
ST-DDT Apr 2, 2023
419edfe
Merge branch 'next' into feat/locale-access-proxy
ST-DDT Apr 4, 2023
e0b8ac2
test: remove expected failure
ST-DDT Apr 4, 2023
fff9ccb
Merge branch 'next' into feat/locale-access-proxy
ST-DDT Apr 5, 2023
fe435ad
Merge branch 'next' into feat/locale-access-proxy
ST-DDT Apr 12, 2023
021e851
chore: apply suggestions
ST-DDT Apr 12, 2023
f69b474
chore: lost commit
ST-DDT Apr 12, 2023
d2a5312
Merge branch 'next' into feat/locale-access-proxy
ST-DDT Apr 13, 2023
dec1659
Merge branch 'next' into feat/locale-access-proxy
ST-DDT Apr 15, 2023
2a4cc3f
chore: apply suggestions
ST-DDT Apr 15, 2023
372e1f2
chore: apply suggestion
ST-DDT Apr 15, 2023
fd80d4f
test: update error message
ST-DDT Apr 15, 2023
4b92071
Update test/faker.spec.ts
ST-DDT Apr 15, 2023
385d4fa
chore: format
ST-DDT Apr 15, 2023
f107258
Merge branch 'next' into feat/locale-access-proxy
ST-DDT Apr 16, 2023
9b298c7
test: add tests for Object.keys
ST-DDT Apr 17, 2023
316941d
Merge branch 'next' into feat/locale-access-proxy
ST-DDT Apr 20, 2023
f99f72c
fix: proxy-impl
ST-DDT Apr 20, 2023
106bf70
Apply suggestions from code review
ST-DDT Apr 20, 2023
d722c6a
Merge branch 'next' into feat/locale-access-proxy
ST-DDT Apr 21, 2023
fbde3ac
Merge branch 'next' into feat/locale-access-proxy
ST-DDT Apr 21, 2023
24e14cf
refactor: use null as not applicable data
ST-DDT Apr 21, 2023
6acf6de
Merge branch 'next' into feat/locale-access-proxy
matthewmayer Apr 22, 2023
aafe702
Merge branch 'next' into feat/locale-access-proxy
ST-DDT Apr 22, 2023
1f29440
Merge branch 'next' into feat/locale-access-proxy
ST-DDT Apr 23, 2023
2ab6023
chore: own review
ST-DDT Apr 23, 2023
783b7ba
Update src/locale-proxy.ts
ST-DDT Apr 23, 2023
f915d49
Merge branch 'next' into feat/locale-access-proxy
ST-DDT Apr 23, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: extend migration guide
ST-DDT committed Apr 2, 2023

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
commit eebccd053389c0b27ce23dd7210a34e3c611065e
9 changes: 9 additions & 0 deletions docs/guide/upgrading.md
Original file line number Diff line number Diff line change
@@ -98,6 +98,15 @@ for (let user of users) {

For more information refer to our [Localization Guide](localization).

### For missing locale data, Faker will now throw instead of returning `undefined` or `a`-`c`

Previously, using `faker.definitions.animal.cat` returned `undefined`, when the data were accessed but missing in that locale, thus `faker.animal.cat()` returned one of `a`-`c` (`arrayElement`'s default value).
These values aren't expected/useful as a fallback and potentially also violate the method's defined return type definitions (in case it doesn't return a string).

We addressed that now by changing the implementation to throwing an error, requesting you to add the missing data instead.
This will also give you detailed information which data are missing.
If you want to check for data you can either use `entry in faker.definitions.category` or use `faker.rawDefinitions.category?.entry` instead.

### `faker.mersenne` and `faker.helpers.repeatString` removed

`faker.mersenne` and `faker.helpers.repeatString` were only ever intended for internal use, and are no longer available.