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

docs: improve extending matchers docs #6121

Merged
merged 2 commits into from
Jul 15, 2024
Merged

Conversation

vorant94
Copy link
Contributor

@vorant94 vorant94 commented Jul 14, 2024

Description

This PR improves the docs for setting up custom matchers. With the current guide I wasn't able to properly configure TypeScript, so I needed to take a look at Testing LIbrary Jest DOM matchers how they handle it. Their approach worked for me, so I suggest updating the docs accordingly.

  • change ambient declaration file to how it is configured inside testing lib since the current way didn't work for me
  • rename MatcherResult to ExpectationResult as this is the current name of custom matcher return type according to source code (see MatchersObject > RawMatcherFn > ExpectationResult)

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

@vorant94 vorant94 force-pushed the main branch 2 times, most recently from 4d1b587 to c20e93f Compare July 14, 2024 09:25
docs/guide/extending-matchers.md Outdated Show resolved Hide resolved
- change ambient declaration file to how it is configured inside [testing lib](https://github.com/testing-library/jest-dom/blob/main/types/vitest.d.ts) since the current way didn't work for me
- rename MatcherResult to ExpectationResult as this is the current name of custom matcher return type according to source code (see MatchersObject > RawMatcherFn > ExpectationResult)
@sheremet-va sheremet-va merged commit 407f12f into vitest-dev:main Jul 15, 2024
14 of 16 checks passed
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.

2 participants