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

feat(expect): add toSatisfy asymmetric matcher #7022

Merged
merged 6 commits into from
Dec 9, 2024

Conversation

hi-ogawa
Copy link
Contributor

@hi-ogawa hi-ogawa commented Dec 5, 2024

Description

I just noticed jest-extended has this https://jest-extended.jestcommunity.dev/docs/matchers/toSatisfy Note that we already have assertion form expect(...).toSatisfy(...) (which uses chai's `.to.satisfy), but there wasn't asymmetric matcher.

One use case this would help is for error assertions like mentioned in

expect(someFnToThrowError).toThrow(expect.toSatisfy((e) => {
  expect(e).toBeInstanceOf(MyError);
  // ...
  return true;
}))

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.

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

Copy link

netlify bot commented Dec 5, 2024

Deploy Preview for vitest-dev ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 13a0b89
🔍 Latest deploy log https://app.netlify.com/sites/vitest-dev/deploys/67525ac4429b8b0008bd043c
😎 Deploy Preview https://deploy-preview-7022--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 site configuration.

@sheremet-va
Copy link
Member

Asymmetric matchers are added automatically if the new assertions is extended with expect.extend - maybe we can do that instead of writing new matchers all the time?

expect.extend({
  toSatisfy() { /* ... */ }
})
expect(22).toSatisfy(() => 22)
expect(22).toEqual(expect.toSatisfy(() => 22))

@hi-ogawa hi-ogawa marked this pull request as ready for review December 6, 2024 07:21
@sheremet-va sheremet-va merged commit f691ad7 into vitest-dev:main Dec 9, 2024
17 checks passed
@hi-ogawa hi-ogawa deleted the feat-toSatisfy-asymmetric branch December 9, 2024 09:32
@AriPerkkio
Copy link
Member

This started to fail tests after merge to main 🤔

@sheremet-va
Copy link
Member

Ah, it's because of #7043. We should also updated the diff here

@AriPerkkio AriPerkkio mentioned this pull request Dec 9, 2024
6 tasks
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.

3 participants