@vitest/snapshot 0.34.7 → 1.0.0-beta.0

package/README.md

@@ -9,20 +9,18 @@ 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
+const client = new SnapshotClient({
+  // you need to provide your own equality check implementation if you use it
   // this function is called when `.toMatchSnapshot({ property: 1 })` is called
-  equalityCheck(received, expected) {
-    return equals(received, expected, [iterableEquality, subsetEquality])
-  }
-}
+  isEqual: (received, expected) => 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()
 
+// you need to implement this yourselves,
+// this depends on your runner
 function getCurrentFilepath() {
   return '/file.spec.ts'
 }
@@ -30,6 +28,8 @@ function getCurrentTestName() {
   return 'test1'
 }
 
+// example for inline snapshots, nothing is required to support regular snapshots,
+// just call `assert` with `isInline: false`
 function wrapper(received) {
   function __INLINE_SNAPSHOT__(inlineSnapshot, message) {
     client.assert({
@@ -37,8 +37,6 @@ function wrapper(received) {
       message,
       isInline: true,
       inlineSnapshot,
-      // you need to implement this yourselves,
-      // this depends on your runner
       filepath: getCurrentFilepath(),
       name: getCurrentTestName(),
     })
@@ -55,14 +53,20 @@ const options = {
   snapshotEnvironment: environment,
 }
 
-await client.setTest(getCurrentFilepath(), getCurrentTestName(), options)
+await client.startCurrentRun(getCurrentFilepath(), getCurrentTestName(), options)
+
+// this will save snapshot to a file which is returned by "snapshotEnvironment.resolvePath"
+client.assert({
+  received: 'some text',
+  isInline: false,
+})
 
 // 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
+const result = await client.finishCurrentRun() // this saves files and returns SnapshotResult
 
 // you can use manager to manage several clients
 const manager = new SnapshotManager(options)

package/dist/index.d.ts

@@ -74,26 +74,23 @@ interface AssertOptions {
     errorMessage?: string;
     rawSnapshot?: RawSnapshotInfo;
 }
+interface SnapshotClientOptions {
+    isEqual?: (received: unknown, expected: unknown) => boolean;
+}
 declare class SnapshotClient {
-    private Service;
+    private options;
     filepath?: string;
     name?: string;
     snapshotState: SnapshotState | undefined;
     snapshotStateMap: Map<string, SnapshotState>;
-    constructor(Service?: typeof SnapshotState);
-    setTest(filepath: string, name: string, options: SnapshotStateOptions): Promise<void>;
+    constructor(options?: SnapshotClientOptions);
+    startCurrentRun(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>;
+    finishCurrentRun(): Promise<SnapshotResult | null>;
     clear(): void;
 }
 

package/dist/index.js

@@ -1346,23 +1346,23 @@ function createMismatchError(message, actual, expected) {
   return error;
 }
 class SnapshotClient {
-  constructor(Service = SnapshotState) {
-    this.Service = Service;
+  constructor(options = {}) {
+    this.options = options;
   }
   filepath;
   name;
   snapshotState;
   snapshotStateMap = /* @__PURE__ */ new Map();
-  async setTest(filepath, name, options) {
+  async startCurrentRun(filepath, name, options) {
     var _a;
     this.filepath = filepath;
     this.name = name;
     if (((_a = this.snapshotState) == null ? void 0 : _a.testFilePath) !== filepath) {
-      this.resetCurrent();
+      await this.finishCurrentRun();
       if (!this.getSnapshotState(filepath)) {
         this.snapshotStateMap.set(
           filepath,
-          await this.Service.create(
+          await SnapshotState.create(
             filepath,
             options
           )
@@ -1382,15 +1382,8 @@ class SnapshotClient {
     var _a;
     (_a = this.snapshotState) == null ? void 0 : _a.markSnapshotsAsCheckedForTest(name);
   }
-  /**
-   * Should be overridden by the consumer.
-   *
-   * Vitest checks equality with @vitest/expect.
-   */
-  equalityCheck(received, expected) {
-    return received === expected;
-  }
   assert(options) {
+    var _a, _b;
     const {
       filepath = this.filepath,
       name = this.name,
@@ -1409,7 +1402,7 @@ class SnapshotClient {
       if (typeof received !== "object" || !received)
         throw new Error("Received value must be an object when the matcher has properties");
       try {
-        const pass2 = this.equalityCheck(received, properties);
+        const pass2 = ((_b = (_a = this.options).isEqual) == null ? void 0 : _b.call(_a, received, properties)) ?? false;
         if (!pass2)
           throw createMismatchError("Snapshot properties mismatched", received, properties);
         else
@@ -1452,7 +1445,7 @@ class SnapshotClient {
     }
     return this.assert(options);
   }
-  async resetCurrent() {
+  async finishCurrentRun() {
     if (!this.snapshotState)
       return null;
     const result = await this.snapshotState.pack();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vitest/snapshot",
   "type": "module",
-  "version": "0.34.7",
+  "version": "1.0.0-beta.0",
   "description": "Vitest snapshot manager",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
@@ -45,7 +45,7 @@
   "devDependencies": {
     "@types/natural-compare": "^1.4.1",
     "natural-compare": "^1.4.0",
-    "@vitest/utils": "0.34.7"
+    "@vitest/utils": "1.0.0-beta.0"
   },
   "scripts": {
     "build": "rimraf dist && rollup -c",