Skip to content

docs(snapshot): gotchas for custom async inline snaphsot matcher#10107

Merged
sheremet-va merged 4 commits intovitest-dev:mainfrom
hi-ogawa:test-snapshot-test-custom-async-inline-snapshot-matcher
Apr 9, 2026
Merged

docs(snapshot): gotchas for custom async inline snaphsot matcher#10107
sheremet-va merged 4 commits intovitest-dev:mainfrom
hi-ogawa:test-snapshot-test-custom-async-inline-snapshot-matcher

Conversation

@hi-ogawa
Copy link
Copy Markdown
Collaborator

@hi-ogawa hi-ogawa commented Apr 9, 2026 •
edited
Loading

Description

Currently users need to manually setup chai error flag at the top of custom matcher. We could technically do the same if we capture new Error automatically in __VITEST_EXTEND_ASSERTION__, but I'm a bit hesitant to do unconditionally as it might hit perf.

vitest/packages/expect/src/jest-extend.ts

Lines 93 to 96 in 6342b35

function __VITEST_EXTEND_ASSERTION__(
this: Chai.AssertionStatic & Chai.Assertion,
...args: any[]
) {

For now, I'd suggest using chai.util.flag(this.assertion, 'error', new Error)) manually for custom inline snapshot matcher since they kinda already looks official-ish API.

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. If the feature is substantial or introduces breaking changes without a discussion, PR might be closed.
  • Ideally, include a test that fails without this PR but passes with it.
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.
  • Please check Allow edits by maintainers to make review process faster. Note that this option is not available for repositories that are owned by Github organizations.

Tests

  • Run the tests with pnpm test:ci.

Documentation

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs command.

Changesets

  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 9, 2026 •
edited
Loading

✅ Deploy Preview for vitest-dev ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 2bdfd50
🔍 Latest deploy log https://app.netlify.com/projects/vitest-dev/deploys/69d6fbc058b09500083ffa2a
😎 Deploy Preview https://deploy-preview-10107--vitest-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@hi-ogawa hi-ogawa changed the title test(snapshot): test custom async inline snapshot matcher docs(snapshot): gotchas for custom async inline snaphsot matcher Apr 9, 2026
@hi-ogawa hi-ogawa marked this pull request as ready for review April 9, 2026 01:09
@sheremet-va sheremet-va merged commit 6d989d8 into vitest-dev:main Apr 9, 2026
16 of 17 checks passed
@hi-ogawa hi-ogawa deleted the test-snapshot-test-custom-async-inline-snapshot-matcher branch April 9, 2026 07:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sheremet-va sheremet-va sheremet-va approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Async custom snapshot

2 participants

@hi-ogawa @sheremet-va