Skip to content

📝 Extract manual setup guide into dedicated page#6844

Merged
dubzzz merged 1 commit into
mainfrom
claude/extract-fastcheck-jest-setup-DsLna
Apr 28, 2026
Merged

📝 Extract manual setup guide into dedicated page#6844
dubzzz merged 1 commit into
mainfrom
claude/extract-fastcheck-jest-setup-DsLna

Conversation

@dubzzz

@dubzzz dubzzz commented Apr 11, 2026 •
edited
Loading

Copy link
Copy Markdown
Owner

Description

Refactor the documentation structure for the "Setting up your test environment" section by extracting the runner-agnostic manual setup patterns into a dedicated page, removing duplication across runner-specific guides.

Changes

  1. New page property-based-testing-manual-setup.md (sidebar_position: 0) — runner-agnostic walkthrough that covers:

    • Generic installation instructions
    • Synchronous property-based test pattern using fc.property + fc.assert
    • Asynchronous test pattern using fc.asyncProperty
    • Recommended use of fc.configureGlobal for sharing settings (timeout alignment, hooks, seeds)
    • Links to runner-specific integration pages and to /docs/configuration/global-settings/ for hook details

  2. Jest page — removed the ~130-line "Manual setup" section (install, recommended setup, sync test, async test, going further) and replaced it with a short pointer that links to the new page and to /docs/configuration/global-settings/#jest for the setupFiles snippet. Connector path stays as the recommended option.

  3. Bun, Node.js, Deno pages — added an :::info Runner-agnostic patterns callout pointing to the new page so readers can find sync/async patterns and configureGlobal guidance in one place. The runner-specific install commands, imports, run commands, and example tests are kept untouched.

Rationale

  • DRY — eliminates duplication of sync/async test patterns and the configureGlobal recommendation across multiple pages
  • Better discoverability — Bun and Node users gain easy access to async-property guidance that previously only lived inside the Jest page
  • Clearer split — runner-specific pages now focus on what is unique to each runner, while shared patterns live in one canonical place

Checklist

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

  • I have a full understanding of every line in this PR — whether the code was hand-written, AI-generated, copied from external sources or produced by any other tool
  • I flagged the impact of my change (minor / patch / major) either by running pnpm run bump or by following the instructions from the changeset bot
  • I kept this PR focused on a single concern and did not bundle unrelated changes
  • I followed the gitmoji specification for the name of the PR, including the package scope (e.g. 🐛(vitest) Something...) when the change targets a package other than fast-check
  • I added relevant tests and they would have failed without my PR (when applicable)

https://claude.ai/code/session_01LduMT1azz85eVZ2YsAk8Aj

@changeset-bot

changeset-bot Bot commented Apr 11, 2026 •
edited
Loading

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: a6ac331

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

@github-actions

github-actions Bot commented Apr 11, 2026

Copy link
Copy Markdown
Contributor

👋 It looks like the PR template was not used for this pull request.

Please edit the PR description to use the template, or close this PR and open a new one that uses it.
Not using the template may result in your change not being reviewed.

The template includes:

  • A Description section
  • A Checklist section with items to verify before submitting

Thank you for your contribution! 🙏

@claude
📝 Extract runner-agnostic manual setup into its own docs page
a6ac331 
Move the "Manual setup" content from the Jest page into a shared,
runner-agnostic `Manual setup` tutorial so Bun, Node, Deno, and Jest
can link to one canonical walkthrough instead of each duplicating the
generic patterns.
@dubzzz
dubzzz force-pushed the claude/extract-fastcheck-jest-setup-DsLna branch from f8036a7 to a6ac331 Compare April 11, 2026 21:56
@pkg-pr-new

pkg-pr-new Bot commented Apr 11, 2026

Copy link
Copy Markdown
@fast-check/ava

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

fast-check

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

@fast-check/jest

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

@fast-check/packaged

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

@fast-check/poisoning

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

@fast-check/vitest

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

@fast-check/worker

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

commit: a6ac331

@codecov

codecov Bot commented Apr 11, 2026 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.86%. Comparing base (9621579) to head (a6ac331).
⚠️ Report is 54 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #6844   +/-   ##
=======================================
  Coverage   94.86%   94.86%           
=======================================
  Files         209      209           
  Lines        5665     5665           
  Branches     1489     1488    -1     
=======================================
  Hits         5374     5374           
  Misses        283      283           
  Partials        8        8
Flag Coverage Δ
tests 94.86% <ø> (ø)

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.

@dubzzz dubzzz changed the title 📚 Extract manual setup guide into dedicated page 📝 Extract manual setup guide into dedicated page Apr 28, 2026
@dubzzz
dubzzz merged commit 6425d59 into main Apr 28, 2026
52 checks passed
@dubzzz
dubzzz deleted the claude/extract-fastcheck-jest-setup-DsLna branch April 28, 2026 20:59
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.

2 participants

@dubzzz @claude