Skip to content

docs(custom_matchers): clarify match interfaces difference #9

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Aug 28, 2025
Merged

docs(custom_matchers): clarify match interfaces difference #9

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
117f04d
docs(custom_matchers): make it clear the difference between match int…
oiagorodrigues Aug 28, 2025
257fe15
Update custom_matchers new interface
oiagorodrigues Aug 28, 2025
cc4181c
03/01: polish the `Matchers` explanation
kettanaito Aug 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions exercises/03.assertions/01.solution.custom-matchers/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,16 @@ There are two interfaces from `vitest` that I extend using module augmentgation:
- `Assertion<T>`, which controls the matchers returned by calling `expect()`;
- `MatchersDeclaration`, which annotates the matcher declarations passed to `expect.extend()`.

<callout-info>Since Vitest 3.2, you can extend the `Matchers` interface to have type-safe assertions in `expect.extend`, `expect().*` and `expect.*` methods at the same time.</callout-info>
Copy link
Member

@kettanaito kettanaito Aug 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The exercise text was written before Vitest 3.2 was released. Let's update the text to reflect the proper way of extending the matchers.

Copy link
Contributor Author

@oiagorodrigues oiagorodrigues Aug 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense. It would require multiple changes, as other exercises are still referencing the old vitest version.

Copy link
Member

@kettanaito kettanaito Aug 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will go through the remaining mentions of this pattern throughout the workshop and fix them!


```diff ts filename=vitest.setup.ts add=3 remove=2,3 highlight=3
declare module 'vitest' {
- interface Assertion<T = any> extends CustomMatchers<T> {}
- interface MatchersDeclaration extends CustomMatchers {}
+ interface Matchers<T> extends CustomMatchers {}
}
```

This is enough for the `.toMatchSchema()` custom matcher to be recognized by TypeScript:

```ts nonumber nocopy
Expand Down
Loading