Vitest
Anthony FuCommunityCreated by Anthony Fu
- Skill
- Tool integration
- Software development
- MIT
- No issues found
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
Vitest is a testing framework built for the Vite ecosystem. It provides a Jest-compatible API and supports ESM, TypeScript, and JSX by default. It shares configuration, transformers, and plugins with Vite applications, allowing for integrated testing workflows. The framework includes features for mocking, snapshot testing, code coverage, and multi-threaded test execution.
What it does
- Provides a Jest-compatible API for writing and running unit tests
- Supports native ESM, TypeScript, and JSX without additional configuration
- Enables mocking of functions, modules, timers, and dates
- Offers built-in code coverage reporting using V8 or Istanbul
- Supports multi-project workspaces and varied test environments like Node, jsdom, and happy-dom
- Includes utilities for snapshot testing, test filtering, and benchmarking
When to use it
- When you need a testing framework that integrates directly with your Vite configuration
- When migrating existing test suites that rely on Jest-compatible APIs
- When you require specific test environments like jsdom or happy-dom for DOM-related testing
- When managing complex test setups across monorepos or multiple projects
Advantages
- Shares configuration and plugins with Vite projects
- Supports parallel test execution via multi-threaded workers
- Provides flexible test environment configuration per file or project
- Includes built-in support for snapshot testing and mocking utilities
Usage examples
- “How do I configure Vitest to use the jsdom environment for my tests?”
- The agent provides the vitest.config.ts configuration snippet using the environment: 'jsdom' property and explains how to install the necessary jsdom package.
- “Can I run different test configurations in the same Vitest process?”
- The agent explains how to use the projects field in the vitest.config.ts file to define multiple test suites with different environments or include patterns.
Install
Download the skill as a ZIP:
https://mp-staging.autogineer.com/agent-skills/antfu/vitest/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip vitest.zip -d .agents/skills
Documentation by Anthony Fu
Vitest is a next-generation testing framework powered by Vite. It provides a Jest-compatible API with native ESM, TypeScript, and JSX support out of the box. Vitest shares the same config, transformers, resolvers, and plugins with your Vite app.
Key Features:
Vite-native: Uses Vite's transformation pipeline for fast HMR-like test updates
Jest-compatible: Drop-in replacement for most Jest test suites
Smart watch mode: Only reruns affected tests based on module graph
Native ESM, TypeScript, JSX support without configuration
Multi-threaded workers for parallel test execution
Built-in coverage via V8 or Istanbul
Snapshot testing, mocking, and spy utilities
The skill is based on Vitest 5.1.0-beta.1, generated at 2026-10-23.
Core
| Topic | Description | Reference |
|---|---|---|
| Configuration | Vitest and Vite config integration, defineConfig usage | core-config |
| CLI | Command line interface, commands and options | core-cli |
| Test API | test/it function, modifiers like skip, only, concurrent | core-test-api |
| Describe API | describe/suite for grouping tests and nested suites | core-describe |
| Expect API | Assertions with toBe, toEqual, matchers and asymmetric matchers | core-expect |
| Hooks | beforeEach, afterEach, beforeAll, afterAll, aroundEach | core-hooks |
Features
| Topic | Description | Reference |
|---|---|---|
| Mocking | Mock functions, modules, timers, dates with vi utilities | features-mocking |
| Snapshots | Snapshot testing with toMatchSnapshot and inline snapshots | features-snapshots |
| Coverage | Code coverage with V8 or Istanbul providers | features-coverage |
| Test Context | Test fixtures, context.expect, test.extend for custom fixtures | features-context |
| Concurrency | Concurrent tests, parallel execution, sharding | features-concurrency |
| Filtering | Filter tests by name, file patterns, tags | features-filtering |
| Test Tags | Label tests with tags to filter runs and apply shared options | features-test-tags |
| Reporters | Built-in reporters, default selection, CI/output config | features-reporters |
| Benchmarking | Write benchmarks with the bench fixture (Tinybench) | features-benchmarking |
Advanced
| Topic | Description | Reference |
|---|---|---|
| Vi Utilities | vi helper: mock, spyOn, fake timers, hoisted, waitFor | advanced-vi |
| Environments | Test environments: node, jsdom, happy-dom, custom | advanced-environments |
| Type Testing | Type-level testing with expectTypeOf and assertType | advanced-type-testing |
| Projects | Multi-project workspaces, different configs per project | advanced-projects |
Files
- ATTRIBUTION.mdAdded by AutoGineer895 B
- GENERATION.md136 B
- LICENSELicence file added by AutoGineer1.1 KiB
- SKILL.md3.6 KiB
- references/advanced-environments.md4.9 KiB
- references/advanced-projects.md7.4 KiB
- references/advanced-type-testing.md4.6 KiB
- references/advanced-vi.md5.8 KiB
- references/core-cli.md4.9 KiB
- references/core-config.md7.7 KiB
- references/core-describe.md3.5 KiB
- references/core-expect.md8.8 KiB
- references/core-hooks.md4.8 KiB
- references/core-test-api.md5.5 KiB
- references/features-benchmarking.md3.9 KiB
- references/features-concurrency.md4.7 KiB
- references/features-context.md5.3 KiB
- references/features-coverage.md5.0 KiB
- references/features-filtering.md4.8 KiB
- references/features-mocking.md9.8 KiB
- references/features-reporters.md4.0 KiB
- references/features-snapshots.md5.2 KiB
- references/features-test-tags.md3.6 KiB
references/features-reporters.md
name: reporters description: Built-in reporters, default selection, and CI/output configuration
Reporters
Select reporters via --reporter or reporters config. Configuring reporters replaces the default list — spread configDefaults.reporters to keep them.
import { configDefaults, defineConfig } from 'vitest/config'
export default defineConfig({
test: {
reporters: ['verbose', ['junit', { suiteName: 'UI tests' }]],
// keep defaults and add one:
// reporters: ['json', ...configDefaults.reporters],
},
})Default Selection
When reporters is unset, Vitest auto-selects:
defaultfor normal terminal runsminimal(aliasagent) when it detects an AI coding agent — only failed tests + errors, no summary or passing logs, optimized to cut token usagegithub-actionsis added whenprocess.env.GITHUB_ACTIONS === 'true'
Built-in Reporters
| Reporter | Use |
|---|---|
default | Summary + collapses passing files; prints full tree for single/failing file |
verbose | One line per finished test (flat list in v4); only reporter that shows annotations on pass |
tree | Like default but always shows each test (the old v3 verbose) |
dot | One dot per test; details only for failures |
minimal / agent | Failures only; best for AI/LLM workflows |
junit | JUnit XML (templated, see below) |
json | Jest-compatible JSON; includes coverageMap when coverage enabled |
tap / tap-flat | TAP (nested / flat) |
html | Interactive UI report (needs @vitest/ui) |
blob | Serialized results for --merge-reports |
github-actions | Workflow annotations + job summary |
hanging-process | Lists processes preventing exit (debugging) |
v4 removed the
basicreporter (equivalent to['default', { summary: false }]). The oldverboseflat behavior moved here; usetreefor the nested view.
Output Files
v5: the
jsonandjunitreporters now write to a file by default (.vitest/json/output.json,.vitest/junit/output.xml) instead of stdout. If you piped output (vitest --reporter=json | jq), read the artifact instead or opt back in withreporters: [['json', { stdout: true }]]. An explicitoutputFileis still respected.
vitest --reporter=json --outputFile=./test-output.jsondefineConfig({
test: {
reporters: ['junit', 'json'],
outputFile: { junit: './junit.xml', json: './report.json' },
},
})JUnit Templating
reporters: [['junit', {
suiteNameTemplate: '{title}', // {title} {filename} {basename} {displayName}
classnameTemplate: '{classname}', // {classname} {title} {suitename} {filename} ...
titleTemplate: '{title}',
ancestorSeparator: ' > ',
addFileAttribute: true,
}]]{filename} is the relative path (use {basename} for the bare name). Templates can also be functions receiving all variables.
HTML Report (v5 paths)
The HTML reporter writes a directory via outputDir (default .vitest); the entry is <outputDir>/index.html. Use singleFile: true for a self-contained shareable file (large; coverage not inlined).
reporters: [['html', { singleFile: true }]]Blob & Merge (CI/sharding)
Blobs default to .vitest/blob/. Label environments with VITEST_BLOB_LABEL or the reporter label option:
vitest run --reporter=blob --outputFile=reports/blob-1.json
vitest --merge-reports=reports --reporter=junit --reporter=defaultBlob reports don't include file attachments — merge attachmentsDir (.vitest/attachments/) separately. --reporter=blob/--merge-reports don't work in watch mode.
Key Points
Configuring
reportersreplaces defaults — spreadconfigDefaults.reportersto keep themThe
minimal/agentreporter is auto-selected for AI agents and minimizes token usageUse
treefor the nested per-test view (old v3verbose)v5 artifacts (blob, attachments, HTML) live under
.vitest/
<!-- Source references: - https://vitest.dev/guide/reporters - https://vitest.dev/config/reporters -->
Requirements and compatibility
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Needs: Needs Node.js
Security
No issues found by our static scan· No issues found
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Created by
- Anthony Fu
- Publisher
- Anthony Fu (Community)
- Source
- antfu/skills · skills/vitest · commit f63e9ec
- Licence
- MIT License (redistribution allowed)
- LICENSE (added by AutoGineer from LICENSE.md)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by Anthony Fu.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download vitest.zip