vitest

Key benefits of Vitest over Jest:

Safety Notice

This listing is imported from skills.sh public index metadata. Review upstream SKILL.md and repository scripts before running.

Copy this and send it to your AI assistant to learn

Install skill "vitest" with this command: npx skills add el-feo/ai-context/el-feo-ai-context-vitest

Key benefits of Vitest over Jest:

  • 2-10x faster test startup (built on Vite and esbuild)

  • Native TypeScript support without ts-jest

  • Hot Module Replacement for instant re-runs

  • Jest-compatible API requiring minimal code changes

  • Modern ESM-first architecture

<quick_start> <automated_migration> RECOMMENDED APPROACH: Use automated codemods for fastest migration.

Option 1: vitest-codemod (recommended)

Install globally

npm install -g @vitest-codemod/jest

Run migration on test files

vitest-codemod jest path/to/tests/**/*.test.js

Or use npx (no installation)

npx @vitest-codemod/jest path/to/tests

Option 2: Codemod.com Platform

Using VS Code extension

Install "Codemod" extension from marketplace

Right-click project → "Run Codemod" → "Jest to Vitest"

Using CLI

npx codemod jest/vitest

What codemods handle automatically:

  • ✓ Convert jest.mock() → vi.mock()

  • ✓ Convert jest.fn() → vi.fn()

  • ✓ Convert jest.spyOn() → vi.spyOn()

  • ✓ Convert jest.setTimeout() → vi.setConfig({ testTimeout })

  • ✓ Update global matchers and timer mocks

  • ✓ Transform jest.requireActual() → vi.importActual()

  • ✓ Update mock resets/clears/restores </automated_migration>

<manual_migration> For users who need manual control or want to understand changes:

  1. Install Vitest

Remove Jest

npm uninstall jest @types/jest ts-jest jest-environment-jsdom

Install Vitest

npm install -D vitest @vitest/ui happy-dom

  1. Create vitest.config.ts

import { defineConfig } from 'vitest/config'

export default defineConfig({ test: { globals: true, // Enable globals for Jest compatibility environment: 'happy-dom', // Faster than jsdom setupFiles: ['./vitest.setup.ts'], clearMocks: true, restoreMocks: true, }, })

  1. Update package.json

{ "scripts": { "test": "vitest", "test:ui": "vitest --ui", "test:run": "vitest run", "test:coverage": "vitest run --coverage" } }

  1. Update TypeScript config

{ "compilerOptions": { "types": ["vitest/globals"] } }

  1. Update mock syntax

// Replace in all test files: jest.fn → vi.fn jest.spyOn → vi.spyOn jest.mock → vi.mock jest.useFakeTimers → vi.useFakeTimers jest.clearAllMocks → vi.clearAllMocks

</manual_migration>

<automated_scripts> For comprehensive migrations with validation and rollback:

Ready-to-run migration scripts available in scripts/ directory:

  • quick-migrate.sh

  • Fast 30-second migration for simple projects

  • comprehensive-migrate.sh

  • Full-featured migration with project detection, backups, and validation

See references/MIGRATION_SCRIPT.md for usage instructions. </automated_scripts> </quick_start>

<critical_differences> <module_mocking> Jest: Auto-returns default export

jest.mock('./module', () => 'hello')

Vitest: Must specify exports explicitly

vi.mock('./module', () => ({ default: 'hello' // Explicit default export required }))

</module_mocking>

<mock_reset_behavior> Jest: mockReset() replaces with empty function returning undefined

Vitest: mockReset() resets to original implementation

To match Jest behavior in Vitest:

mockFn.mockReset() mockFn.mockImplementation(() => undefined)

</mock_reset_behavior>

<globals_configuration> Jest: Globals enabled by default

Vitest: Must explicitly enable:

export default defineConfig({ test: { globals: true // Enable for Jest compatibility } })

Then add to tsconfig.json :

{ "compilerOptions": { "types": ["vitest/globals"] } }

</globals_configuration>

<auto_mocking> Jest: Files in mocks/ auto-load

Vitest: Must call vi.mock() explicitly, or add to setupFiles :

// vitest.setup.ts vi.mock('./path/to/module')

</auto_mocking>

<async_tests> Jest: Supports callback style with done()

Vitest: Use async/await or Promises

// Before (Jest) test('async test', (done) => { setTimeout(() => { expect(true).toBe(true) done() }, 100) })

// After (Vitest) test('async test', async () => { await new Promise(resolve => { setTimeout(() => { expect(true).toBe(true) resolve() }, 100) }) })

</async_tests> </critical_differences>

<common_issues> <testing_library_cleanup> Problem: Auto-cleanup doesn't run when globals: false

Solution: Manually import cleanup in setup file

// vitest.setup.ts import { cleanup } from '@testing-library/react' import { afterEach } from 'vitest'

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

</testing_library_cleanup>

<path_aliases> Problem: Jest's moduleNameMapper not working

Solution: Configure in vitest.config.ts

import { defineConfig } from 'vitest/config' import path from 'path'

export default defineConfig({ resolve: { alias: { '@': path.resolve(__dirname, './src'), '@components': path.resolve(__dirname, './src/components'), } } })

</path_aliases>

<coverage_differences> Problem: Coverage numbers don't match Jest

Solution: Vitest uses V8 by default. For Istanbul (Jest's provider):

npm install -D @vitest/coverage-istanbul

export default defineConfig({ test: { coverage: { provider: 'istanbul' } } })

</coverage_differences>

<snapshot_names> Problem: Test names in snapshots use > separator instead of spaces

Jest: "describe title test title" Vitest: "describe title > test title"

Solution: Regenerate snapshots with npm run test -u

</snapshot_names> </common_issues>

<best_practices>

  • Use happy-dom over jsdom

  • 2-3x faster for most use cases

  • Enable globals for easier migration - Set globals: true in config

  • Use watch mode during development - npm run test (default behavior)

  • Leverage UI mode for debugging - npm run test:ui opens browser interface

  • Configure auto-cleanup - Set clearMocks: true and restoreMocks: true

  • Use workspace configuration for monorepos - See CONFIG.md </best_practices>

<performance_optimization>

export default defineConfig({ test: { environment: 'node', // or 'happy-dom' instead of 'jsdom' maxWorkers: 4, // Increase for parallel execution fileParallelism: true, testTimeout: 5000, isolate: false, // Faster but use with caution pool: 'threads', // or 'forks' for better isolation } })

Pool options:

  • threads (default) - Fast, CPU-intensive tests

  • forks

  • Better isolation, more memory

  • vmThreads

  • Best for TypeScript performance </performance_optimization>

<migration_workflow> Recommended migration process:

Prepare

  • Ensure all Jest tests passing

  • Commit working state

  • Create migration branch

Install dependencies

npm install -D vitest @vitest/ui happy-dom

Run automated codemod

npx @vitest-codemod/jest src/**/*.test.ts

Create configuration

  • Add vitest.config.ts with globals: true

  • Update package.json scripts

  • Update tsconfig.json types

Run tests and fix issues

npm run test

  • Address failures one by one

  • Check MIGRATION.md for solutions

Update CI/CD

  • Replace Jest commands with Vitest

  • Update coverage paths if needed

Cleanup

npm uninstall jest @types/jest ts-jest rm jest.config.js

</migration_workflow>

<common_commands>

npm run test # Watch mode npm run test:run # Run once (CI mode) npm run test:coverage # With coverage npm run test:ui # Visual UI npm run test path/to/file.test.ts # Specific file npm run test -t "pattern" # Matching pattern npm run test --environment jsdom # Specific environment npm run test -u # Update snapshots

</common_commands>

<detailed_references> For comprehensive information:

<success_criteria> Migration is successful when:

  • All tests passing with npm run test:run

  • Coverage reports generate correctly

  • CI/CD pipeline runs tests successfully

  • No jest references remain in codebase

  • TypeScript types resolve without errors

  • Test execution is noticeably faster (2-10x improvement) </success_criteria>

<when_successful> After successful migration, you should observe:

  • 5x faster cold start - Initial test run (10s → 2s typical)

  • 5x faster watch mode - Hot reload (5s → <1s typical)

  • 2x faster execution - Overall test suite runtime

  • 10x faster TypeScript tests - No ts-jest compilation overhead

  • Better DX - Instant feedback, visual UI, better error messages </when_successful>

Source Transparency

This detail page is rendered from real SKILL.md content. Trust labels are metadata-based hints, not a safety guarantee.

Related Skills

Related by shared tags or category signals.

General

tailscale

No summary provided by upstream source.

Repository SourceNeeds Review
General

cucumber-gherkin

No summary provided by upstream source.

Repository SourceNeeds Review
General

rubocop

No summary provided by upstream source.

Repository SourceNeeds Review
General

rspec

No summary provided by upstream source.

Repository SourceNeeds Review