Skip to content

docs: promote Vitest as recommended test runner #2805

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
cexbrayat merged 2 commits into from
Apr 7, 2026
+36 −12
Merged

docs: promote Vitest as recommended test runner #2805

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
08349be
docs: promote Vitest as recommended test runner
mvanhorn Apr 3, 2026
2c2964e
docs: update French and Chinese installation pages
mvanhorn Apr 3, 2026
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
16 changes: 12 additions & 4 deletions docs/installation/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,20 @@ yarn add --dev @vue/test-utils

## Usage

Vue Test Utils is framework agnostic - you can use it with whichever test runner you like. The easiest way to try it out is using [Jest](https://jestjs.io/), a popular test runner.
Vue Test Utils is framework agnostic - you can use it with whichever test runner you like.

To load `.vue` files with Jest, you will need `vue-jest`. `vue-jest` v5 is the one that supports Vue 3. It is still in alpha, much like the rest of the Vue.js 3 ecosystem, so if you find a bug please report it [here](https://github.com/vuejs/vue-jest/) and specify you are using `vue-jest` v5.
### Vitest (Recommended)

You can install it with `vue-jest@next`. Then you need to configure it with Jest's [transform](https://jestjs.io/docs/en/configuration#transform-objectstring-pathtotransformer--pathtotransformer-object) option.
[Vitest](https://vitest.dev/) is the recommended test runner for Vue projects. It is built on Vite, supports `.vue` files out of the box, and provides a fast, modern testing experience with native ESM support.

If you don't want to configure it yourself, you can get a minimal repository with everything set up [here](https://github.com/lmiller1990/vtu-next-demo).
```shell
npm install --save-dev vitest
```

No additional transform configuration is needed when using Vitest with a Vite-based project. See the [Vitest getting started guide](https://vitest.dev/guide/) for more details.

### Jest

You can also use [Jest](https://jestjs.io/) with Vue Test Utils. To load `.vue` files with Jest, you will need `vue-jest`. You can install it with `vue-jest@next` and configure it with Jest's [transform](https://jestjs.io/docs/en/configuration#transform-objectstring-pathtotransformer--pathtotransformer-object) option.

Continue reading to learn more about Vue Test Utils.