💥 Error with cause by default

[dubzzz]

Description

Until now, fast-check have been merging the content and stack of the original Error that caused the property to fail into its own Error. With the recent (2022) introduction of cause on Errors, this complex logic can be dropped in favor of the native cause mechanism.

This PR makes cause mode the default. Before this PR, toggling it was possible via errorWithCause: true on fc.assert.

Given not all test runners properly support causes attached to the Error, we offer a fallback for users willing to preserve the old behaviour. It can be toggled via includeErrorInReport: true on fc.assert.

Related to #4416.

Checklist — Don't delete this checklist and make sure you do the following before opening the PR

• The name of my PR follows gitmoji specification
• My PR references one of several related issues (if any)
  • New features or breaking changes must come with an associated Issue or Discussion
  • My PR does not add any new dependency without an associated Issue or Discussion
• My PR includes bumps details, please run yarn bump and flag the impacts properly
• My PR adds relevant tests and they would have failed without my PR (when applicable)

Advanced

💥 Breaking change: The display of errors being reported by fast-check will change. Many test runners do support that but some still don't support it so a flag will have to be pass for them to display the errors correctly.

[changeset-bot]

🦋 Changeset detected

Latest commit: b3be369

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 5 packages

Name	Type
fast-check	Major
@fast-check/ava	Patch
@fast-check/jest	Patch
@fast-check/vitest	Patch
@fast-check/worker	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[pkg-pr-new]

Open in Stackblitz • @fast-check/examples

@fast-check/ava

npm i https://pkg.pr.new/@fast-check/ava@5590

@fast-check/expect-type

npm i https://pkg.pr.new/@fast-check/expect-type@5590

@fast-check/jest

npm i https://pkg.pr.new/@fast-check/jest@5590

fast-check

npm i https://pkg.pr.new/fast-check@5590

@fast-check/packaged

npm i https://pkg.pr.new/@fast-check/packaged@5590

@fast-check/poisoning

npm i https://pkg.pr.new/@fast-check/poisoning@5590

@fast-check/vitest

npm i https://pkg.pr.new/@fast-check/vitest@5590

@fast-check/worker

npm i https://pkg.pr.new/@fast-check/worker@5590

commit: b3be369

[github-actions]

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.77%. Comparing base (d5108bb) to head (b3be369).
Report is 5 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5590      +/-   ##
==========================================
+ Coverage   94.70%   94.77%   +0.06%     
==========================================
  Files         235      235              
  Lines       10036    10036              
  Branches     2821     2827       +6     
==========================================
+ Hits         9505     9512       +7     
+ Misses        531      524       -7     

Flag	Coverage Δ
unit-tests	94.77% <100.00%> (+0.06%)	⬆️
unit-tests-18.x-Linux	94.77% <100.00%> (+0.06%)	⬆️
unit-tests-20.x-Linux	94.77% <100.00%> (+0.06%)	⬆️
unit-tests-22.x-Linux	94.77% <100.00%> (+0.06%)	⬆️
unit-tests-latest-Linux	94.77% <100.00%> (+0.11%)	⬆️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[github-actions]

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

[github-actions]

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