ever-co/ever-works / .agents/skills/vitest
vitest
VerifiedVitest fast unit testing framework powered by Vite with Jest-compatible API. Use when writing tests, mocking, configuring coverage, or working with test filtering and fixtures.
| File | Kind | Size |
|---|---|---|
| GENERATION.md | markdown | 136 B |
| SKILL.md | skill md | 4.1 KB |
| references/advanced-environments.md | markdown | 4.0 KB |
| references/advanced-projects.md | markdown | 4.3 KB |
| references/advanced-type-testing.md | markdown | 4.5 KB |
| references/advanced-vi.md | markdown | 4.5 KB |
| references/core-cli.md | markdown | 3.3 KB |
| references/core-config.md | markdown | 3.2 KB |
| references/core-describe.md | markdown | 3.4 KB |
| references/core-expect.md | markdown | 4.5 KB |
| references/core-hooks.md | markdown | 4.3 KB |
| references/core-test-api.md | markdown | 3.9 KB |
| references/features-concurrency.md | markdown | 4.0 KB |
| references/features-context.md | markdown | 4.2 KB |
| references/features-coverage.md | markdown | 3.2 KB |
| references/features-filtering.md | markdown | 3.4 KB |
| references/features-mocking.md | markdown | 4.7 KB |
| references/features-snapshots.md | markdown | 3.5 KB |
references/core-expect.md
View on GitHub---
name: expect-api
description: Assertions with matchers, asymmetric matchers, and custom matchers
---
# Expect API
Vitest uses Chai assertions with Jest-compatible API.
## Basic Assertions
```ts
import { expect, test } from 'vitest';
test('assertions', () => {
// Equality
expect(1 + 1).toBe(2); // Strict equality (===)
expect({ a: 1 }).toEqual({ a: 1 }); // Deep equality
// Truthiness
expect(true).toBeTruthy();
expect(false).toBeFalsy();
expect(null).toBeNull();
expect(undefined).toBeUndefined();
expect('value').toBeDefined();
// Numbers
expect(10).toBeGreaterThan(5);
expect(10).toBeGreaterThanOrEqual(10);
expect(5).toBeLessThan(10);
expect(0.1 + 0.2).toBeCloseTo(0.3, 5);
// Strings
expect('hello world').toMatch(/world/);
expect('hello').toContain('ell');
// Arrays
expect([1, 2, 3]).toContain(2);
expect([{ a: 1 }]).toContainEqual({ a: 1 });
expect([1, 2, 3]).toHaveLength(3);
// Objects
expect({ a: 1, b: 2 }).toHaveProperty('a');
expect({ a: 1, b: 2 }).toHaveProperty('a', 1);
expect({ a: { b: 1 } }).toHaveProperty('a.b', 1);
expect({ a: 1 }).toMatchObject({ a: 1 });
// Types
expect('string').toBeTypeOf('string');
expect(new Date()).toBeInstanceOf(Date);
});
```
## Negation
```ts
expect(1).not.toBe(2);
expect({ a: 1 }).not.toEqual({ a: 2 });
```
## Error Assertions
```ts
// Sync errors - wrap in function
expect(() => throwError()).toThrow();
expect(() => throwError()).toThrow('message');
expect(() => throwError()).toThrow(/pattern/);
expect(() => throwError()).toThrow(CustomError);
// Async errors - use rejects
await expect(asyncThrow()).rejects.toThrow('error');
```
## Promise Assertions
```ts
// Resolves
await expect(Promise.resolve(1)).resolves.toBe(1);
await expect(fetchData()).resolves.toEqual({ data: true });
// Rejects
await expect(Promise.reject('error')).rejects.toBe('error');
await expect(failingFetch()).rejects.toThrow();
```
## Spy/Mock Assertions
```ts
const fn = vi.fn();
fn('arg1', 'arg2');
fn('arg3');
expect(fn).toHaveBeenCalled();
expect(fn).toHaveBeenCalledTimes(2);
expect(fn).toHaveBeenCalledWith('arg1', 'arg2');
expect(fn).toHaveBeenLastCalledWith('arg3');
expect(fn).toHaveBeenNthCalledWith(1, 'arg1', 'arg2');
expect(fn).toHaveReturned();
expect(fn).toHaveReturnedWith(value);
```
## Asymmetric Matchers
Use inside `toEqual`, `toHaveBeenCalledWith`, etc:
```ts
expect({ id: 1, name: 'test' }).toEqual({
id: expect.any(Number),
name: expect.any(String)
});
expect({ a: 1, b: 2, c: 3 }).toEqual(expect.objectContaining({ a: 1 }));
expect([1, 2, 3, 4]).toEqual(expect.arrayContaining([1, 3]));
expect('hello world').toEqual(expect.stringContaining('world'));
expect('hello world').toEqual(expect.stringMatching(/world$/));
expect({ value: null }).toEqual({
value: expect.anything() // Matches anything except null/undefined
});
// Negate with expect.not
expect([1, 2]).toEqual(expect.not.arrayContaining([3]));
```
## Soft Assertions
Continue test after failure:
```ts
expect.soft(1).toBe(2); // Marks test failed but continues
expect.soft(2).toBe(3); // Also runs
// All failures reported at end
```
## Poll Assertions
Retry until passes:
```ts
await expect.poll(() => fetchStatus()).toBe('ready');
await expect.poll(() => document.querySelector('.element'), { interval: 100, timeout: 5000 }).toBeTruthy();
```
## Assertion Count
```ts
test('async assertions', async () => {
expect.assertions(2); // Exactly 2 assertions must run
await doAsync((data) => {
expect(data).toBeDefined();
expect(data.id).toBe(1);
});
});
test('at least one', () => {
expect.hasAssertions(); // At least 1 assertion must run
});
```
## Extending Matchers
```ts
expect.extend({
toBeWithinRange(received, floor, ceiling) {
const pass = received >= floor && received <= ceiling;
return {
pass,
message: () => `expected ${received} to be within range ${floor} - ${ceiling}`
};
}
});
test('custom matcher', () => {
expect(100).toBeWithinRange(90, 110);
});
```
## Snapshot Assertions
```ts
expect(data).toMatchSnapshot()
expect(data).toMatchInlineSnapshot(`{ "id": 1 }`)
await expect(result).toMatchFileSnapshot('./expected.json')
expect(() => throw new Error('fail')).toThrowErrorMatchingSnapshot()
```
## Key Points
- Use `toBe` for primitives, `toEqual` for objects/arrays
- `toStrictEqual` checks undefined properties and array sparseness
- Always `await` async assertions (`resolves`, `rejects`, `poll`)
- Use context's `expect` in concurrent tests for correct tracking
- `toThrow` requires wrapping sync code in a function
<!--
Source references:
- https://vitest.dev/api/expect.html
-->
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| finishing-a-development-branchobra/superpowersUse when implementation is complete, all tests pass, and you need to decide how to integrate the work | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| systematic-debuggingobra/superpowersUse when encountering any bug, test failure, or unexpected behavior, before proposing fixes | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| test-driven-developmentobra/superpowersUse when implementing any feature or bugfix, before writing implementation code | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| skill-creatoranthropics/skillsCreate new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, edit, or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |