Skip to content

✅ Provide cause when doc generation fails#6472

Merged
dubzzz merged 1 commit into
mainfrom
test-better-cause-doc
Jan 21, 2026
Merged

✅ Provide cause when doc generation fails#6472
dubzzz merged 1 commit into
mainfrom
test-better-cause-doc

Conversation

@dubzzz

@dubzzz dubzzz commented Jan 21, 2026 •
edited
Loading

Copy link
Copy Markdown
Owner

Description

Until now when the generation of the doc was failing we just received an error telling us about the snippet that failed to execute. Now that Node supports errors coming with causes, we can leverage them to have a more understandable error.

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 pnpm run 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 tests
  • Impacts: Easier to understand failures of docs test

@dubzzz
✅ Provide cause when doc generation fails
409b979 
Until now when the generation of the doc was failing we just received an error telling us about the snippet that failed to execute. Now that Node supports errors coming with causes, we can leverage them to have a more understandable error.
@changeset-bot

changeset-bot Bot commented Jan 21, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 409b979

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@dubzzz
dubzzz enabled auto-merge (squash) January 21, 2026 17:24
@pkg-pr-new

pkg-pr-new Bot commented Jan 21, 2026

Copy link
Copy Markdown
@fast-check/ava

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

@fast-check/expect-type

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

fast-check

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

@fast-check/jest

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

@fast-check/packaged

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

@fast-check/poisoning

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

@fast-check/vitest

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

@fast-check/worker

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

commit: 409b979

@github-actions

github-actions Bot commented Jan 21, 2026

Copy link
Copy Markdown
Contributor

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

@dubzzz
dubzzz merged commit e763162 into main Jan 21, 2026
131 of 149 checks passed
@dubzzz
dubzzz deleted the test-better-cause-doc branch January 21, 2026 21:15
@codecov

codecov Bot commented Jan 21, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.85%. Comparing base (bca770a) to head (409b979).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #6472   +/-   ##
=======================================
  Coverage   94.85%   94.85%           
=======================================
  Files         207      207           
  Lines        5581     5581           
  Branches     1467     1467           
=======================================
  Hits         5294     5294           
  Misses        274      274           
  Partials       13       13
Flag Coverage Δ
tests 94.85% <ø> (ø)

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.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@ghost-of-high-heart ghost-of-high-heart Bot mentioned this pull request Apr 3, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@dubzzz