💥 Include invalid dates by default

[dubzzz]

Description

In v3, fc.date was not producing "Invalid Date" values by default. One has to specify noInvalidDate: false to get some. With this PR we now default the flag to false when not specified: in other words, the new default will be to produce invalid dates except asked explicitly not to.

After that change, if you want not to produce "Invalid Date", you'll have to use:

// in v3, it was only producing valid dates
fc.date()

// equivalent in v4
fc.date({noInvalidDate: true})

//---

// in v3, including invalid dates required users to pass an extra constraint to the arbitrary
fc.date({noInvalidDate: false})

// equivalent in v4
fc.date()

You can also prepare yourself to v4 by already toggling: noInvalidDate: false on your fc.date.

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: Change defaults on date

[changeset-bot]

🦋 Changeset detected

Latest commit: 4001a66

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@5589

@fast-check/expect-type

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

@fast-check/jest

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

fast-check

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

@fast-check/packaged

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

@fast-check/poisoning

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

@fast-check/vitest

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

@fast-check/worker

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

commit: 4001a66

[github-actions]

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

[github-actions]

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.90%. Comparing base (11bc738) to head (4001a66).
Report is 5 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #5589   +/-   ##
=======================================
  Coverage   94.90%   94.90%           
=======================================
  Files         235      235           
  Lines       10024    10024           
  Branches     2823     2823           
=======================================
  Hits         9513     9513           
  Misses        511      511           

Flag	Coverage Δ
unit-tests	94.90% <100.00%> (ø)
unit-tests-18.x-Linux	94.90% <100.00%> (ø)
unit-tests-20.x-Linux	94.90% <100.00%> (ø)
unit-tests-22.x-Linux	94.90% <100.00%> (ø)
unit-tests-latest-Linux	94.90% <100.00%> (ø)

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.