@vitest/snapshot 0.30.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2021-Present Anthony Fu <https://github.com/antfu>
+Copyright (c) 2021-Present Matias Capeletto <https://github.com/patak-dev>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,75 @@
+# @vitest/snapshot
+
+Lightweight implementation of Jest's snapshots.
+
+## Usage
+
+```js
+import { SnapshotClient } from '@vitest/snapshot'
+import { NodeSnapshotEnvironment } from '@vitest/snapshot/environment'
+import { SnapshotManager } from '@vitest/snapshot/manager'
+
+export class CustomSnapshotClient extends SnapshotClient {
+  // by default, @vitest/snapshot checks equality with `!==`
+  // you need to provide your own equality check implementation
+  // this function is called when `.toMatchSnapshot({ property: 1 })` is called
+  equalityCheck(received, expected) {
+    return equals(received, expected, [iterableEquality, subsetEquality])
+  }
+}
+
+const client = new CustomSnapshotClient()
+// class that implements snapshot saving and reading
+// by default uses fs module, but you can provide your own implementation depending on the environment
+const environment = new NodeSnapshotEnvironment()
+
+function getCurrentFilepath() {
+  return '/file.spec.ts'
+}
+function getCurrentTestName() {
+  return 'test1'
+}
+
+function wrapper(received) {
+  function __INLINE_SNAPSHOT__(inlineSnapshot, message) {
+    client.assert({
+      received,
+      message,
+      isInline: true,
+      inlineSnapshot,
+      // you need to implement this yourselves,
+      // this depends on your runner
+      filepath: getCurrentFilepath(),
+      name: getCurrentTestName(),
+    })
+  }
+  return {
+    // the name is hard-coded, it should be inside another function, so Vitest can find the actual test file where it was called (parses call stack trace + 2)
+    // you can override this behaviour in SnapshotState's `_inferInlineSnapshotStack` method by providing your own SnapshotState to SnapshotClient constructor
+    toMatchInlineSnapshot: (...args) => __INLINE_SNAPSHOT__(...args),
+  }
+}
+
+const options = {
+  updateSnapshot: 'new',
+  snapshotEnvironment: environment,
+}
+
+await client.setTest(getCurrentFilepath(), getCurrentTestName(), options)
+
+// uses "pretty-format", so it requires quotes
+// also naming is hard-coded when parsing test files
+wrapper('text 1').toMatchInlineSnapshot()
+wrapper('text 2').toMatchInlineSnapshot('"text 2"')
+
+const result = await client.resetCurrent() // this saves files and returns SnapshotResult
+
+// you can use manager to manage several clients
+const manager = new SnapshotManager(options)
+manager.add(result)
+
+// do something
+// and then read the summary
+
+console.log(manager.summary)
+```

package/dist/environment-8fbbf71b.d.ts

@@ -0,0 +1,12 @@
+interface SnapshotEnvironment {
+    getVersion(): string;
+    getHeader(): string;
+    resolvePath(filepath: string): Promise<string>;
+    resolveRawPath(testPath: string, rawPath: string): Promise<string>;
+    prepareDirectory(filepath: string): Promise<void>;
+    saveSnapshotFile(filepath: string, snapshot: string): Promise<void>;
+    readSnapshotFile(filepath: string): Promise<string | null>;
+    removeSnapshotFile(filepath: string): Promise<void>;
+}
+
+export { SnapshotEnvironment as S };

package/dist/environment.d.ts

@@ -0,0 +1,14 @@
+import { S as SnapshotEnvironment } from './environment-8fbbf71b.js';
+
+declare class NodeSnapshotEnvironment implements SnapshotEnvironment {
+    getVersion(): string;
+    getHeader(): string;
+    resolveRawPath(testPath: string, rawPath: string): Promise<string>;
+    resolvePath(filepath: string): Promise<string>;
+    prepareDirectory(filepath: string): Promise<void>;
+    saveSnapshotFile(filepath: string, snapshot: string): Promise<void>;
+    readSnapshotFile(filepath: string): Promise<string | null>;
+    removeSnapshotFile(filepath: string): Promise<void>;
+}
+
+export { NodeSnapshotEnvironment, SnapshotEnvironment };

package/dist/environment.js

@@ -0,0 +1,40 @@
+import { promises, existsSync } from 'node:fs';
+import { isAbsolute, resolve, dirname, join, basename } from 'pathe';
+
+class NodeSnapshotEnvironment {
+  getVersion() {
+    return "1";
+  }
+  getHeader() {
+    return `// Snapshot v${this.getVersion()}`;
+  }
+  async resolveRawPath(testPath, rawPath) {
+    return isAbsolute(rawPath) ? rawPath : resolve(dirname(testPath), rawPath);
+  }
+  async resolvePath(filepath) {
+    return join(
+      join(
+        dirname(filepath),
+        "__snapshots__"
+      ),
+      `${basename(filepath)}.snap`
+    );
+  }
+  async prepareDirectory(filepath) {
+    await promises.mkdir(filepath, { recursive: true });
+  }
+  async saveSnapshotFile(filepath, snapshot) {
+    await promises.writeFile(filepath, snapshot, "utf-8");
+  }
+  async readSnapshotFile(filepath) {
+    if (!existsSync(filepath))
+      return null;
+    return promises.readFile(filepath, "utf-8");
+  }
+  async removeSnapshotFile(filepath) {
+    if (existsSync(filepath))
+      await promises.unlink(filepath);
+  }
+}
+
+export { NodeSnapshotEnvironment };

package/dist/index-2c775746.d.ts

@@ -0,0 +1,59 @@
+import { OptionsReceived } from 'pretty-format';
+import { S as SnapshotEnvironment } from './environment-8fbbf71b.js';
+
+interface RawSnapshotInfo {
+    file: string;
+    readonly?: boolean;
+    content?: string;
+}
+
+type SnapshotData = Record<string, string>;
+type SnapshotUpdateState = 'all' | 'new' | 'none';
+interface SnapshotStateOptions {
+    updateSnapshot: SnapshotUpdateState;
+    snapshotEnvironment: SnapshotEnvironment;
+    expand?: boolean;
+    snapshotFormat?: OptionsReceived;
+    resolveSnapshotPath?: (path: string, extension: string) => string;
+}
+interface SnapshotMatchOptions {
+    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;
+}
+
+export { RawSnapshotInfo as R, SnapshotStateOptions as S, UncheckedSnapshot as U, SnapshotMatchOptions as a, SnapshotResult as b, SnapshotData as c, SnapshotUpdateState as d, SnapshotSummary as e };

package/dist/index.d.ts

@@ -0,0 +1,112 @@
+import { S as SnapshotStateOptions, a as SnapshotMatchOptions, b as SnapshotResult, R as RawSnapshotInfo } from './index-2c775746.js';
+export { c as SnapshotData, e as SnapshotSummary, d as SnapshotUpdateState, U as UncheckedSnapshot } from './index-2c775746.js';
+import { S as SnapshotEnvironment } from './environment-8fbbf71b.js';
+import { Plugin, Plugins } from 'pretty-format';
+
+interface ParsedStack {
+    method: string;
+    file: string;
+    line: number;
+    column: number;
+}
+
+/**
+ * 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.
+ */
+
+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 _rawSnapshots;
+    private _uncheckedKeys;
+    private _snapshotFormat;
+    private _environment;
+    private _fileExists;
+    added: number;
+    expand: boolean;
+    matched: number;
+    unmatched: number;
+    updated: number;
+    private constructor();
+    static create(testFilePath: string, options: SnapshotStateOptions): Promise<SnapshotState>;
+    get environment(): SnapshotEnvironment;
+    markSnapshotsAsCheckedForTest(testName: string): void;
+    protected _inferInlineSnapshotStack(stacks: ParsedStack[]): ParsedStack | null;
+    private _addSnapshot;
+    clear(): void;
+    save(): Promise<SaveStatus>;
+    getUncheckedCount(): number;
+    getUncheckedKeys(): Array<string>;
+    removeUncheckedKeys(): void;
+    match({ testName, received, key, inlineSnapshot, isInline, error, rawSnapshot, }: SnapshotMatchOptions): SnapshotReturnOptions;
+    pack(): Promise<SnapshotResult>;
+}
+
+interface AssertOptions {
+    received: unknown;
+    filepath?: string;
+    name?: string;
+    message?: string;
+    isInline?: boolean;
+    properties?: object;
+    inlineSnapshot?: string;
+    error?: Error;
+    errorMessage?: string;
+    rawSnapshot?: RawSnapshotInfo;
+}
+declare class SnapshotClient {
+    private Service;
+    filepath?: string;
+    name?: string;
+    snapshotState: SnapshotState | undefined;
+    snapshotStateMap: Map<string, SnapshotState>;
+    constructor(Service?: typeof SnapshotState);
+    setTest(filepath: string, name: string, options: SnapshotStateOptions): Promise<void>;
+    getSnapshotState(filepath: string): SnapshotState;
+    clearTest(): void;
+    skipTestSnapshots(name: string): void;
+    /**
+     * Should be overridden by the consumer.
+     *
+     * Vitest checks equality with @vitest/expect.
+     */
+    equalityCheck(received: unknown, expected: unknown): boolean;
+    assert(options: AssertOptions): void;
+    assertRaw(options: AssertOptions): Promise<void>;
+    resetCurrent(): Promise<SnapshotResult | null>;
+    clear(): void;
+}
+
+/**
+ * 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 function addSerializer(plugin: Plugin): void;
+declare function getSerializers(): Plugins;
+
+declare function stripSnapshotIndentation(inlineSnapshot: string): string;
+
+export { SnapshotClient, SnapshotMatchOptions, SnapshotResult, SnapshotState, SnapshotStateOptions, addSerializer, getSerializers, stripSnapshotIndentation };