Skip to content

Conversation

dubzzz
Copy link
Owner

@dubzzz dubzzz commented Jan 8, 2025

Description

The API of property has been updated in a non-breaking manner during v3. Now, let's seal that move to drop unneeded code complexity, drop useless tests... but also make the API clearer and way simpler to use and manage.

The implementations of IRawProperty now have to implement runBeforeEach and runAfterEach. If they themselves wrap another IRawProperty, they probably should at least call these methods when called on their side of them. The migration from v3, consists into implementing the two methods.

ChecklistDon'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 the execution flow of properties. Only impacts on advanced users building their own custom runners or their own property type.

**:boom: Breaking change**

The API of property has been updated in a non-breaking manner during v3. Now, let's seal that move to drop unneeded code complexity, drop useless tests... but also make the API clearer and way simpler to use and manage.

The implementations of `IRawProperty` now have to implement `runBeforeEach` and `runAfterEach`. If they themselves wrap another `IRawProperty`, they probably should at least call these methods when called on their side of them. The migration from v3, consists into implementing the two methods.
Copy link

changeset-bot bot commented Jan 8, 2025

🦋 Changeset detected

Latest commit: e7a3741

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

Copy link

pkg-pr-new bot commented Jan 8, 2025

Open in Stackblitz@fast-check/examples

@fast-check/ava

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

@fast-check/expect-type

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

fast-check

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

@fast-check/jest

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

@fast-check/packaged

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

@fast-check/poisoning

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

@fast-check/vitest

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

@fast-check/worker

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

commit: e7a3741

Copy link
Contributor

github-actions bot commented Jan 8, 2025

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

Copy link
Contributor

github-actions bot commented Jan 8, 2025

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

@dubzzz dubzzz merged commit ee62923 into main Jan 8, 2025
54 checks passed
@dubzzz dubzzz deleted the pr-4208 branch January 8, 2025 18:35
Copy link

codecov bot commented Jan 8, 2025

Codecov Report

Attention: Patch coverage is 88.63636% with 5 lines in your changes missing coverage. Please review.

Project coverage is 94.90%. Comparing base (bb46b92) to head (e7a3741).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
.../fast-check/src/check/property/UnbiasedProperty.ts 44.44% 5 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5581      +/-   ##
==========================================
- Coverage   94.91%   94.90%   -0.01%     
==========================================
  Files         235      235              
  Lines       10043    10024      -19     
  Branches     2836     2825      -11     
==========================================
- Hits         9532     9513      -19     
  Misses        511      511              
Flag Coverage Δ
unit-tests 94.90% <88.63%> (-0.01%) ⬇️
unit-tests-18.x-Linux 94.90% <88.63%> (-0.01%) ⬇️
unit-tests-20.x-Linux 94.90% <88.63%> (-0.01%) ⬇️
unit-tests-22.x-Linux 94.90% <88.63%> (-0.01%) ⬇️
unit-tests-latest-Linux 94.90% <88.63%> (-0.01%) ⬇️

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant