Skip to content

Add Vitest cleanup hint to react-testing-library setup docs #1422

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

Merged
Merged
Changes from all commits
Commits
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
38 changes: 38 additions & 0 deletions docs/react-testing-library/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -510,3 +510,41 @@ And register it using mocha's `-r` flag:
```
mocha --require ./mocha-watch-cleanup-after-each.js
```

### Auto Cleanup in Vitest

If you're using Vitest and want automatic cleanup to work, you can
[enable globals](https://vitest.dev/config/#globals) through its configuration
file:

```ts title="vitest.config.ts"
import {defineConfig} from 'vitest/config'

export default defineConfig({
test: {
globals: true,
},
})
```

If you don't want to enable globals, you can import `cleanup` and call it
manually in a top-level `afterEach` hook:

```ts title="vitest.config.ts"
import {defineConfig} from 'vitest/config'

export default defineConfig({
test: {
setupFiles: ['vitest-cleanup-after-each.ts'],
},
})
```

```ts title="vitest-cleanup-after-each.ts"
import {cleanup} from '@testing-library/react'
import {afterEach} from 'vitest'

afterEach(() => {
cleanup()
})
```