From 7906df0b171fb0512a4db069303f0d81873db883 Mon Sep 17 00:00:00 2001 From: silverwind Date: Tue, 4 Oct 2022 11:18:47 +0200 Subject: [PATCH] Add `vitest` info to docs (#515) --- website/docs/getting-started/setup.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/website/docs/getting-started/setup.md b/website/docs/getting-started/setup.md index b2e3d5ee..b1d9b38c 100644 --- a/website/docs/getting-started/setup.md +++ b/website/docs/getting-started/setup.md @@ -37,3 +37,23 @@ To automatically extend `expect` with all matchers, you can use "setupFilesAfterEnv": ["jest-extended/all"] } ``` + +## Use with `vitest` + +`jest-extended` works with `vitest` because their `expect.extend` API is compatible. In your setup script: + +```javascript +import {expect} from "vitest"; +import * as matchers from "jest-extended"; +expect.extend(matchers); +``` + +Add this setup script to your `vitest.config.js`: + +```javascript +export default defineConfig({ + test: { + setupFiles: ["./testSetup.js"], + }, +}); +```