✨ Implement arbitrary for ulid

[vecerek]

Implements #4009

Adds arbitrary for ulid, according to the ulid spec.

Category:

• ✨ Introduce new features
• 📝 Add or update documentation
• ✅ Add or update tests
• 🐛 Fix a bug
• 🏷️ Add or update types
• ⚡️ Improve performance
• Other(s): ...

Potential impacts:

• Generated values
• Shrink values
• Performance
• Typings
• Other(s): ...

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 4d82303:

Sandbox	Source
Vanilla	Configuration
@fast-check/examples	Configuration

[dubzzz]

I just did a quick pass on the PR from my mobile and it looks good. I'll just re-read it before approving. Thank you so much for this contribution.

[codecov]

Codecov Report

Merging #4020 (5cdda2a) into main (a6c40ca) will decrease coverage by 0.01%.
The diff coverage is 93.33%.

❗ Current head 5cdda2a differs from pull request most recent head 4d82303. Consider uploading reports for the commit 4d82303 to get more accurate results

@@            Coverage Diff             @@
##             main    #4020      +/-   ##
==========================================
- Coverage   94.61%   94.60%   -0.01%     
==========================================
  Files         209      211       +2     
  Lines        5848     5893      +45     
  Branches     1344     1351       +7     
==========================================
+ Hits         5533     5575      +42     
- Misses        299      302       +3     
  Partials       16       16              

Flag	Coverage Δ
unit-tests	94.60% <93.33%> (-0.01%)	⬇️
unit-tests-14.x-Linux	94.60% <93.33%> (-0.01%)	⬇️
unit-tests-16.x-Linux	94.60% <93.33%> (-0.01%)	⬇️
unit-tests-18.x-Linux	94.58% <93.33%> (-0.03%)	⬇️
unit-tests-latest-Linux	94.60% <93.33%> (-0.01%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
packages/fast-check/src/arbitrary/ulid.ts	92.85% <92.85%> (ø)
...arbitrary/_internals/mappers/UintToBase32String.ts	93.10% <93.10%> (ø)
packages/fast-check/src/fast-check-default.ts	100.00% <100.00%> (ø)

[vecerek]

@dubzzz would you like me to address the formatting/linting issues and the requirement to declare the version bump? I may need some guidance with the latter.

[dubzzz]

For the first one, you have to run:

yarn format

For the bumps (declare minor on fast-check and mark all others as unchanged):

yarn version:bump

[vecerek]

Thanks for the help, @dubzzz. I believe I addressed all the outstanding issues now 🙂

[dubzzz]

Just two minor comments. We should also add the doc part for ulid and the no regression e2e test

[vecerek]

@dubzzz I've generated the jest snapshot covering ulids for the regression tests, and added some web documentation, as well. Let me know what you think.

[dubzzz]

Looks perfect. Thanks for the contribution. I'll just recheck one last time from a computer but it seems perfect

[vecerek]

@dubzzz I had to run yarn workspace fast-check update:examples. I wasn't aware examples were auto-generated but it seems obvious in retrospect 😄

[dubzzz]

Perfect 👍

[dubzzz]

Will be merged in a few minutes. Just waiting the tests to run. I'll try to release it soon