dubzzz / fast-check

Property based testing framework for JavaScript (like QuickCheck) written in TypeScript
https://fast-check.dev/
MIT License
4.25k stars 176 forks source link

✨ Simplify `limitShrink` before releasing #5112

Closed dubzzz closed 1 month ago

dubzzz commented 1 month ago

Description

We align the API of limitShrink with other arbitraries referencing compulsory settings. Instead of asking htem to be provided via an object/record, these options are passed as dedicated parameters.

We follow the same logic for limitShrink.

ChecklistDon't delete this checklist and make sure you do the following before opening the PR

Advanced

codesandbox-ci[bot] commented 1 month ago

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 1d73f412c50a5b91f80fd50dffb216b4d57308f2:

Sandbox Source
@fast-check/examples Configuration
github-actions[bot] commented 1 month ago

👋 A preview of the new documentation is available at: http://668ce2acd4752648da4f5e0a--dubzzz-fast-check.netlify.app

codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 83.33333% with 1 line in your changes missing coverage. Please review.

Project coverage is 96.90%. Comparing base (a462acf) to head (1d73f41). Report is 3 commits behind head on main.

Files Patch % Lines
packages/fast-check/src/arbitrary/limitShrink.ts 83.33% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #5112 +/- ## ========================================== - Coverage 96.90% 96.90% -0.01% ========================================== Files 218 218 Lines 16533 16521 -12 Branches 2701 2702 +1 ========================================== - Hits 16022 16010 -12 Misses 511 511 ``` | [Flag](https://app.codecov.io/gh/dubzzz/fast-check/pull/5112/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nicolas+DUBIEN) | Coverage Δ | | |---|---|---| | [unit-tests](https://app.codecov.io/gh/dubzzz/fast-check/pull/5112/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nicolas+DUBIEN) | `96.90% <83.33%> (-0.01%)` | :arrow_down: | | [unit-tests-18.x-Linux](https://app.codecov.io/gh/dubzzz/fast-check/pull/5112/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nicolas+DUBIEN) | `96.90% <83.33%> (-0.01%)` | :arrow_down: | | [unit-tests-20.x-Linux](https://app.codecov.io/gh/dubzzz/fast-check/pull/5112/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nicolas+DUBIEN) | `96.90% <83.33%> (-0.01%)` | :arrow_down: | | [unit-tests-22.x-Linux](https://app.codecov.io/gh/dubzzz/fast-check/pull/5112/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nicolas+DUBIEN) | `96.90% <83.33%> (-0.01%)` | :arrow_down: | | [unit-tests-latest-Linux](https://app.codecov.io/gh/dubzzz/fast-check/pull/5112/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nicolas+DUBIEN) | `96.90% <83.33%> (-0.01%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nicolas+DUBIEN#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.