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://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-context.md
name: test-context-fixtures description: Test context, custom fixtures with test.extend (builder pattern), scopes, and test.override
Test Context & Fixtures
Built-in Context
Every test receives context as its first argument:
test('context', ({ task, expect, skip, signal, annotate }) => {
console.log(task.name) // Test metadata (readonly)
expect(1).toBe(1) // Expect bound to this test
skip(condition, 'reason') // Skip dynamically
})Properties:
task— test metadata (name, file, etc.)expect— expect bound to this test (required for concurrent snapshot tests)skip(condition?, message?)— skip the testsignal(3.2+) —AbortSignalaborted on timeout/cancel/bailannotate(message, type?, attachment?)(3.2+) — attach reporter annotationsonTestFinished(fn)/onTestFailed(fn)— per-test cleanup/handlersbench(v5) — benchmark fixture (only in*.bench.tsfiles)
Custom Fixtures — Builder Pattern (4.1+, recommended)
.extend(name, options?, fixture) infers types automatically. Use onCleanup for teardown:
import { test as baseTest } from 'vitest'
export const test = baseTest
// Plain value — type inferred as { port: number; host: string }
.extend('config', { port: 3000, host: 'localhost' })
// Function fixture — can read previously defined fixtures
.extend('server', async ({ config }, { onCleanup }) => {
const server = await startServer(config)
onCleanup(() => server.close()) // runs after test/scope ends
return server
})
test('uses server', ({ config, server }) => {
expect(server.url).toContain(String(config.port))
})
onCleanupcan be called once per fixture. For multiple resources, split into separate fixtures.
Fixture Options
const test = baseTest
.extend('metrics', { auto: true }, () => new Metrics()) // runs for every test
.extend('config', { scope: 'worker' }, () => loadConfig()) // once per worker
.extend('db', { scope: 'file' }, async ({ config }, { onCleanup }) => {
const db = await createDatabase(config)
onCleanup(() => db.close())
return db
})
.extend('baseUrl', { injected: true }, () => 'http://localhost:3000') // overridable via configObject Syntax (Playwright-compatible)
Uses the use() callback; types must be declared manually:
const test = baseTest.extend<{ page: Page; baseUrl: string }>({
page: async ({}, use) => {
const page = await browser.newPage()
await use(page) // test runs here
await page.close() // cleanup after
},
baseUrl: 'http://localhost:3000',
})Tuple form sets options: fixture: [async ({}, use) => {…}, { scope: 'file' }].
Fixture Scopes (3.2+)
| Scope | Lifetime | Can access |
|---|---|---|
test (default) | each test | worker + file + test fixtures + built-in context |
file | once per file | worker + file fixtures |
worker | once per worker process | only worker fixtures |
Only test-scoped fixtures can access the built-in context (task, expect, …). In file/worker fixtures use expect.getState().testPath for the file path. By default every file is its own worker, so file and worker behave the same unless isolation is disabled.
Injected Fixtures (per-project values)
// fixtures.ts
const test = baseTest.extend('url', { injected: true }, '/default')
// vitest.config.ts — provide per project
defineConfig({
test: {
projects: [
{ test: { name: 'prod', provide: { url: 'https://prod' } } },
],
},
})Read raw provided values without fixtures via import { inject } from 'vitest'.
Overriding Fixtures — test.override (4.1+)
test.override replaces fixture values for a suite and its children (replaces the deprecated test.scoped):
describe('production', () => {
test
.override('config', { port: 8080, host: 'api.example.com' })
.override('debug', false) // chainable
test('uses prod config', ({ server }) => {
expect(server.url).toBe('http://api.example.com:8080')
})
})
// Function override (reads other fixtures) with cleanup
test.override('db', async ({ config }, { onCleanup }) => {
const db = await createTestDatabase(config)
onCleanup(() => db.drop())
return db
})You cannot introduce new fixtures or change scope/auto via override; use test.extend for new fixtures.
Composing & Hooks
Extend an already-extended test, and use type-aware hooks on the extended test:
import { test as dbTest } from './db-test'
export const test = dbTest.extend('user', ({ db }) => db.createUser())
test.beforeEach(({ db }) => db.seed()) // sees fixtures
test.beforeAll(({ db }) => db.migrate()) // file/worker fixtures only (4.1+)
test.aroundAll(async (run, { db }) => db.tx(run))Key Points
Prefer the builder pattern — types are inferred, cleanup via
onCleanupFixtures are lazy — only initialized when destructured
Always destructure
{ db }(notcontext.db)Use
{ scope: 'file' | 'worker' }for expensive shared resourcesUse
test.override(nottest.scoped) to vary fixture values per suiteUse
{ injected: true }+ projectprovidefor per-project values
<!-- Source references: - https://vitest.dev/guide/test-context.html -->
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 or Anthony Fu.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download vitest.zip