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

📝 Add warning on `noShrink` #5097

Closed dubzzz closed 1 month ago

dubzzz commented 1 month ago

Description

Just documentation.

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 2037f105bfee73746b22aaf175de6c4b803418c4:

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

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

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 96.89%. Comparing base (8483134) to head (2037f10). Report is 4 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #5097 +/- ## ======================================= Coverage 96.89% 96.89% ======================================= Files 215 215 Lines 16384 16384 Branches 2670 2671 +1 ======================================= Hits 15875 15875 Misses 509 509 ``` | [Flag](https://app.codecov.io/gh/dubzzz/fast-check/pull/5097/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/5097/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nicolas+DUBIEN) | `96.89% <ø> (ø)` | | | [unit-tests-18.x-Linux](https://app.codecov.io/gh/dubzzz/fast-check/pull/5097/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nicolas+DUBIEN) | `96.89% <ø> (ø)` | | | [unit-tests-20.x-Linux](https://app.codecov.io/gh/dubzzz/fast-check/pull/5097/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nicolas+DUBIEN) | `96.89% <ø> (ø)` | | | [unit-tests-22.x-Linux](https://app.codecov.io/gh/dubzzz/fast-check/pull/5097/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nicolas+DUBIEN) | `96.89% <ø> (ø)` | | | [unit-tests-latest-Linux](https://app.codecov.io/gh/dubzzz/fast-check/pull/5097/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Nicolas+DUBIEN) | `96.89% <ø> (ø)` | | 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.