Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 Document integration with other test runners #5121

Merged
merged 1 commit into from
Jul 12, 2024

Conversation

dubzzz
Copy link
Owner

@dubzzz dubzzz commented Jul 12, 2024

Description

Integrating fast-check with test runners is crucial for users to be able to use it. As such we started a few months ago to document some integrations (Jest only). We planned to add others but never did that until now.

The newly added batch is around native test runners coming with runtimes. Others will come such as Ava and Vitest but so far we focused on the bare metal integrations directly with runtimes.

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

  • Category: 📝 Add or update documentation
  • Impacts: None

Integrating fast-check with test runners is crucial for users to be able to use it. As such we started a few months ago to document some integrations (Jest only). We planned to add others but never did that until now.

The newly added batch is around native test runners coming with runtimes. Others will come such as Ava and Vitest but so far we focused on the bare metal integrations directly with runtimes.
@dubzzz dubzzz enabled auto-merge (squash) July 12, 2024 10:01
Copy link

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 d397c36:

Sandbox Source
@fast-check/examples Configuration

Copy link
Contributor

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

Copy link

codecov bot commented Jul 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.90%. Comparing base (a462acf) to head (d397c36).
Report is 13 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5121      +/-   ##
==========================================
- 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 Coverage Δ
unit-tests 96.90% <ø> (-0.01%) ⬇️
unit-tests-18.x-Linux 96.90% <ø> (-0.01%) ⬇️
unit-tests-20.x-Linux 96.90% <ø> (-0.01%) ⬇️
unit-tests-22.x-Linux 96.90% <ø> (-0.01%) ⬇️
unit-tests-latest-Linux 96.90% <ø> (-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.

@dubzzz dubzzz merged commit addef65 into main Jul 12, 2024
58 checks passed
@dubzzz dubzzz deleted the test-runner-integration-doc branch July 12, 2024 10:12
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