This commit is contained in:
2026-08-14 16:03:47 +01:00
parent fd53e3f4fb
commit dfdc3b2840
2463 changed files with 186456 additions and 111315 deletions
+4
View File
@@ -1,5 +1,7 @@
# @vitest/snapshot
[![NPM version](https://img.shields.io/npm/v/@vitest/snapshot?color=a1b858&label=)](https://npmx.dev/package/@vitest/snapshot)
Lightweight implementation of Jest's snapshots.
## Usage
@@ -82,3 +84,5 @@ manager.add(result)
console.log(manager.summary)
```
[GitHub](https://github.com/vitest-dev/vitest/tree/main/packages/snapshot) | [Documentation](https://vitest.dev/guide/snapshot)
@@ -1,9 +1,4 @@
interface ParsedStack {
method: string;
file: string;
line: number;
column: number;
}
import { ParsedStack } from '@vitest/utils';
interface SnapshotEnvironment {
getVersion: () => string;
@@ -19,4 +14,4 @@ interface SnapshotEnvironmentOptions {
snapshotsDirName?: string;
}
export type { ParsedStack as P, SnapshotEnvironment as S, SnapshotEnvironmentOptions as a };
export type { SnapshotEnvironment as S, SnapshotEnvironmentOptions as a };
+2 -1
View File
@@ -1,4 +1,5 @@
import { S as SnapshotEnvironment, a as SnapshotEnvironmentOptions } from './environment.d-DHdQ1Csl.js';
import { S as SnapshotEnvironment, a as SnapshotEnvironmentOptions } from './environment.d-DOJxxZV9.js';
import '@vitest/utils';
declare class NodeSnapshotEnvironment implements SnapshotEnvironment {
private options;
+1 -1
View File
@@ -1,5 +1,5 @@
import { promises, existsSync } from 'node:fs';
import { resolve, isAbsolute, dirname, join, basename } from 'pathe';
import { isAbsolute, resolve, dirname, join, basename } from 'pathe';
class NodeSnapshotEnvironment {
constructor(options = {}) {
+26 -82
View File
@@ -1,85 +1,8 @@
import { S as SnapshotStateOptions, a as SnapshotMatchOptions, b as SnapshotResult, R as RawSnapshotInfo } from './rawSnapshot.d-lFsMJFUd.js';
export { c as SnapshotData, d as SnapshotSerializer, e as SnapshotSummary, f as SnapshotUpdateState, U as UncheckedSnapshot } from './rawSnapshot.d-lFsMJFUd.js';
import { S as SnapshotEnvironment, P as ParsedStack } from './environment.d-DHdQ1Csl.js';
import { S as SnapshotState, a as SnapshotStateOptions, b as SnapshotResult, R as RawSnapshotInfo, D as DomainSnapshotAdapter } from './rawSnapshot.d-D_X3-62x.js';
export { c as DomainMatchResult, d as SnapshotData, e as SnapshotMatchOptions, f as SnapshotSerializer, g as SnapshotSummary, h as SnapshotUpdateState, U as UncheckedSnapshot } from './rawSnapshot.d-D_X3-62x.js';
import { Plugin, Plugins } from '@vitest/pretty-format';
/**
* Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
declare class DefaultMap<
K,
V
> extends Map<K, V> {
private defaultFn;
constructor(defaultFn: (key: K) => V, entries?: Iterable<readonly [K, V]>);
get(key: K): V;
}
declare class CounterMap<K> extends DefaultMap<K, number> {
constructor();
_total: number | undefined;
valueOf(): number;
increment(key: K): void;
total(): number;
}
interface SnapshotReturnOptions {
actual: string;
count: number;
expected?: string;
key: string;
pass: boolean;
}
interface SaveStatus {
deleted: boolean;
saved: boolean;
}
declare class SnapshotState {
testFilePath: string;
snapshotPath: string;
private _counters;
private _dirty;
private _updateSnapshot;
private _snapshotData;
private _initialData;
private _inlineSnapshots;
private _inlineSnapshotStacks;
private _testIdToKeys;
private _rawSnapshots;
private _uncheckedKeys;
private _snapshotFormat;
private _environment;
private _fileExists;
expand: boolean;
private _added;
private _matched;
private _unmatched;
private _updated;
get added(): CounterMap<string>;
set added(value: number);
get matched(): CounterMap<string>;
set matched(value: number);
get unmatched(): CounterMap<string>;
set unmatched(value: number);
get updated(): CounterMap<string>;
set updated(value: number);
private constructor();
static create(testFilePath: string, options: SnapshotStateOptions): Promise<SnapshotState>;
get environment(): SnapshotEnvironment;
markSnapshotsAsCheckedForTest(testName: string): void;
clearTest(testId: string): void;
protected _inferInlineSnapshotStack(stacks: ParsedStack[]): ParsedStack | null;
private _addSnapshot;
save(): Promise<SaveStatus>;
getUncheckedCount(): number;
getUncheckedKeys(): Array<string>;
removeUncheckedKeys(): void;
match({ testId, testName, received, key, inlineSnapshot, isInline, error, rawSnapshot }: SnapshotMatchOptions): SnapshotReturnOptions;
pack(): Promise<SnapshotResult>;
}
export { S as SnapshotEnvironment } from './environment.d-DOJxxZV9.js';
import '@vitest/utils';
interface AssertOptions {
received: unknown;
@@ -97,6 +20,23 @@ interface AssertOptions {
error?: Error;
errorMessage?: string;
rawSnapshot?: RawSnapshotInfo;
assertionName?: string;
}
interface AssertDomainOptions extends Omit<AssertOptions, "received"> {
received: unknown;
adapter: DomainSnapshotAdapter<any, any>;
}
interface AssertDomainPollOptions extends Omit<AssertDomainOptions, "received"> {
poll: () => Promise<unknown> | unknown;
timeout?: number;
interval?: number;
}
/** Same shape as expect.extend custom matcher result (SyncExpectationResult from @vitest/expect) */
interface MatchResult {
pass: boolean;
message: () => string;
actual?: unknown;
expected?: unknown;
}
interface SnapshotClientOptions {
isEqual?: (received: unknown, expected: unknown) => boolean;
@@ -110,7 +50,10 @@ declare class SnapshotClient {
skipTest(filepath: string, testName: string): void;
clearTest(filepath: string, testId: string): void;
getSnapshotState(filepath: string): SnapshotState;
match(options: AssertOptions): MatchResult;
assert(options: AssertOptions): void;
matchDomain(options: AssertDomainOptions): MatchResult;
pollMatchDomain(options: AssertDomainPollOptions): Promise<MatchResult>;
assertRaw(options: AssertOptions): Promise<void>;
clear(): void;
}
@@ -127,4 +70,5 @@ declare function stripSnapshotIndentation(inlineSnapshot: string): string;
declare function addSerializer(plugin: Plugin): void;
declare function getSerializers(): Plugins;
export { SnapshotClient, SnapshotEnvironment, SnapshotMatchOptions, SnapshotResult, SnapshotState, SnapshotStateOptions, addSerializer, getSerializers, stripSnapshotIndentation };
export { DomainSnapshotAdapter, SnapshotClient, SnapshotResult, SnapshotState, SnapshotStateOptions, addSerializer, getSerializers, stripSnapshotIndentation };
export type { MatchResult };
+576 -825
View File
File diff suppressed because it is too large Load Diff
+3 -2
View File
@@ -1,6 +1,7 @@
import { S as SnapshotStateOptions, e as SnapshotSummary, b as SnapshotResult } from './rawSnapshot.d-lFsMJFUd.js';
import { a as SnapshotStateOptions, g as SnapshotSummary, b as SnapshotResult } from './rawSnapshot.d-D_X3-62x.js';
import '@vitest/pretty-format';
import './environment.d-DHdQ1Csl.js';
import '@vitest/utils';
import './environment.d-DOJxxZV9.js';
declare class SnapshotManager {
options: Omit<SnapshotStateOptions, "snapshotEnvironment">;
+1 -1
View File
@@ -1,4 +1,4 @@
import { join, dirname, basename, resolve, isAbsolute } from 'pathe';
import { join, dirname, basename, isAbsolute, resolve } from 'pathe';
class SnapshotManager {
summary;
+205
View File
@@ -0,0 +1,205 @@
import { OptionsReceived, Plugin } from '@vitest/pretty-format';
import { ParsedStack } from '@vitest/utils';
import { S as SnapshotEnvironment } from './environment.d-DOJxxZV9.js';
interface DomainMatchResult {
pass: boolean;
message?: string;
/**
* The captured value viewed through the template's lens.
*
* Where the template uses patterns (e.g. regexes) or omits details,
* the resolved string adopts those patterns. Where the template doesn't
* match, the resolved string uses literal captured values instead.
*
* Used for two purposes:
* - **Diff display** (actual side): compared against `expected`
* so the diff highlights only genuine mismatches, not pattern-vs-literal noise.
* - **Snapshot update** (`--update`): written as the new snapshot content,
* preserving user-edited patterns from matched regions while incorporating
* actual values for mismatched regions.
*
* When omitted, falls back to `render(capture(received))` (the raw rendered value).
*/
resolved?: string;
/**
* The stored template re-rendered as a string, representing what the user
* originally wrote or last saved.
*
* Used as the expected side in diff display.
*
* When omitted, falls back to the raw snapshot string from the snap file
* or inline snapshot.
*/
expected?: string;
}
interface DomainSnapshotAdapter<
Captured = unknown,
Expected = unknown
> {
name: string;
capture: (received: unknown) => Captured;
render: (captured: Captured) => string;
parseExpected: (input: string) => Expected;
match: (captured: Captured, expected: Expected) => DomainMatchResult;
}
/**
* Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
declare class DefaultMap<
K,
V
> extends Map<K, V> {
private defaultFn;
constructor(defaultFn: (key: K) => V, entries?: Iterable<readonly [K, V]>);
get(key: K): V;
}
declare class CounterMap<K> extends DefaultMap<K, number> {
constructor();
_total: number | undefined;
valueOf(): number;
increment(key: K): void;
total(): number;
}
interface SnapshotReturnOptions {
actual: string;
count: number;
expected?: string;
key: string;
pass: boolean;
}
interface SaveStatus {
deleted: boolean;
saved: boolean;
}
interface ExpectedSnapshot {
key: string;
count: number;
data?: string;
markAsChecked: () => void;
}
declare class SnapshotState {
testFilePath: string;
snapshotPath: string;
private _counters;
private _dirty;
private _updateSnapshot;
private _snapshotData;
private _initialData;
private _inlineSnapshots;
private _inlineSnapshotStacks;
private _testIdToKeys;
private _rawSnapshots;
private _uncheckedKeys;
private _snapshotFormat;
private _environment;
private _fileExists;
expand: boolean;
private _added;
private _matched;
private _unmatched;
private _updated;
get added(): CounterMap<string>;
set added(value: number);
get matched(): CounterMap<string>;
set matched(value: number);
get unmatched(): CounterMap<string>;
set unmatched(value: number);
get updated(): CounterMap<string>;
set updated(value: number);
private constructor();
static create(testFilePath: string, options: SnapshotStateOptions): Promise<SnapshotState>;
get snapshotUpdateState(): SnapshotUpdateState;
get environment(): SnapshotEnvironment;
markSnapshotsAsCheckedForTest(testName: string): void;
clearTest(testId: string): void;
protected _inferInlineSnapshotStack(stacks: ParsedStack[]): ParsedStack | null;
private _addSnapshot;
private _resolveKey;
private _resolveInlineStack;
private _reconcile;
save(): Promise<SaveStatus>;
getUncheckedCount(): number;
getUncheckedKeys(): Array<string>;
removeUncheckedKeys(): void;
probeExpectedSnapshot(options: Pick<SnapshotMatchOptions, "testName" | "testId" | "isInline" | "inlineSnapshot">): ExpectedSnapshot;
match({ testId, testName, received, key, inlineSnapshot, isInline, error, rawSnapshot, assertionName }: SnapshotMatchOptions): SnapshotReturnOptions;
processDomainSnapshot({ testId, received, expectedSnapshot, matchResult, isInline, error, assertionName }: ProcessDomainSnapshotOptions): SnapshotReturnOptions;
pack(): Promise<SnapshotResult>;
}
type SnapshotData = Record<string, string>;
type SnapshotUpdateState = "all" | "new" | "none";
type SnapshotSerializer = Plugin;
interface SnapshotStateOptions {
updateSnapshot: SnapshotUpdateState;
snapshotEnvironment: SnapshotEnvironment;
expand?: boolean;
snapshotFormat?: OptionsReceived;
resolveSnapshotPath?: (path: string, extension: string, context?: any) => string;
}
interface SnapshotMatchOptions {
testId: string;
testName: string;
received: unknown;
key?: string;
inlineSnapshot?: string;
isInline: boolean;
error?: Error;
rawSnapshot?: RawSnapshotInfo;
assertionName?: string;
}
interface ProcessDomainSnapshotOptions {
testId: string;
received: string;
expectedSnapshot: ExpectedSnapshot;
matchResult?: DomainMatchResult;
isInline?: boolean;
assertionName?: string;
error?: Error;
}
interface SnapshotResult {
filepath: string;
added: number;
fileDeleted: boolean;
matched: number;
unchecked: number;
uncheckedKeys: Array<string>;
unmatched: number;
updated: number;
}
interface UncheckedSnapshot {
filePath: string;
keys: Array<string>;
}
interface SnapshotSummary {
added: number;
didUpdate: boolean;
failure: boolean;
filesAdded: number;
filesRemoved: number;
filesRemovedList: Array<string>;
filesUnmatched: number;
filesUpdated: number;
matched: number;
total: number;
unchecked: number;
uncheckedKeysByFile: Array<UncheckedSnapshot>;
unmatched: number;
updated: number;
}
interface RawSnapshotInfo {
file: string;
readonly?: boolean;
content?: string;
}
export { SnapshotState as S };
export type { DomainSnapshotAdapter as D, RawSnapshotInfo as R, UncheckedSnapshot as U, SnapshotStateOptions as a, SnapshotResult as b, DomainMatchResult as c, SnapshotData as d, SnapshotMatchOptions as e, SnapshotSerializer as f, SnapshotSummary as g, SnapshotUpdateState as h };
-61
View File
@@ -1,61 +0,0 @@
import { OptionsReceived, Plugin } from '@vitest/pretty-format';
import { S as SnapshotEnvironment } from './environment.d-DHdQ1Csl.js';
type SnapshotData = Record<string, string>;
type SnapshotUpdateState = "all" | "new" | "none";
type SnapshotSerializer = Plugin;
interface SnapshotStateOptions {
updateSnapshot: SnapshotUpdateState;
snapshotEnvironment: SnapshotEnvironment;
expand?: boolean;
snapshotFormat?: OptionsReceived;
resolveSnapshotPath?: (path: string, extension: string, context?: any) => string;
}
interface SnapshotMatchOptions {
testId: string;
testName: string;
received: unknown;
key?: string;
inlineSnapshot?: string;
isInline: boolean;
error?: Error;
rawSnapshot?: RawSnapshotInfo;
}
interface SnapshotResult {
filepath: string;
added: number;
fileDeleted: boolean;
matched: number;
unchecked: number;
uncheckedKeys: Array<string>;
unmatched: number;
updated: number;
}
interface UncheckedSnapshot {
filePath: string;
keys: Array<string>;
}
interface SnapshotSummary {
added: number;
didUpdate: boolean;
failure: boolean;
filesAdded: number;
filesRemoved: number;
filesRemovedList: Array<string>;
filesUnmatched: number;
filesUpdated: number;
matched: number;
total: number;
unchecked: number;
uncheckedKeysByFile: Array<UncheckedSnapshot>;
unmatched: number;
updated: number;
}
interface RawSnapshotInfo {
file: string;
readonly?: boolean;
content?: string;
}
export type { RawSnapshotInfo as R, SnapshotStateOptions as S, UncheckedSnapshot as U, SnapshotMatchOptions as a, SnapshotResult as b, SnapshotData as c, SnapshotSerializer as d, SnapshotSummary as e, SnapshotUpdateState as f };
+10 -5
View File
@@ -1,11 +1,11 @@
{
"name": "@vitest/snapshot",
"type": "module",
"version": "4.0.18",
"version": "4.1.9",
"description": "Vitest snapshot manager",
"license": "MIT",
"funding": "https://opencollective.com/vitest",
"homepage": "https://github.com/vitest-dev/vitest/tree/main/packages/snapshot#readme",
"homepage": "https://vitest.dev/guide/snapshot",
"repository": {
"type": "git",
"url": "git+https://github.com/vitest-dev/vitest.git",
@@ -14,6 +14,11 @@
"bugs": {
"url": "https://github.com/vitest-dev/vitest/issues"
},
"keywords": [
"vitest",
"test",
"snapshot"
],
"sideEffects": false,
"exports": {
".": {
@@ -40,12 +45,12 @@
"dependencies": {
"magic-string": "^0.30.21",
"pathe": "^2.0.3",
"@vitest/pretty-format": "4.0.18"
"@vitest/pretty-format": "4.1.9",
"@vitest/utils": "4.1.9"
},
"devDependencies": {
"@types/natural-compare": "^1.4.3",
"natural-compare": "^1.4.0",
"@vitest/utils": "4.0.18"
"natural-compare": "^1.4.0"
},
"scripts": {
"build": "premove dist && rollup -c",