feat(snapshot): ability to skip snapshot from custom serializer + attest example

.gitignore

@@ -28,3 +28,4 @@ test/**/__screenshots__/**/*
 test/browser/fixtures/update-snapshot/basic.test.ts
 test/cli/fixtures/browser-multiple/basic-*
 .vitest-reports
+.attest

packages/pretty-format/src/index.ts

@@ -332,6 +332,9 @@ function printPlugin(
       )
   }
   catch (error: any) {
+    if (error instanceof PrettyFormatSkipSnapshotError) {
+      throw error
+    }
     throw new PrettyFormatPluginError(error.message, error.stack)
   }
   if (typeof printed !== 'string') {
@@ -543,3 +546,5 @@ export const plugins: {
   ReactElement,
   ReactTestComponent,
 }
+
+export class PrettyFormatSkipSnapshotError extends Error {}

packages/snapshot/src/index.ts

@@ -1,7 +1,7 @@
 export { SnapshotClient } from './client'
 
 export { stripSnapshotIndentation } from './port/inlineSnapshot'
-export { addSerializer, getSerializers } from './port/plugins'
+export { addSerializer, getSerializers, skipSnapshot } from './port/plugins'
 export { default as SnapshotState } from './port/state'
 
 export type {

packages/snapshot/src/port/plugins.ts

@@ -9,7 +9,7 @@ import type {
   Plugin as PrettyFormatPlugin,
   Plugins as PrettyFormatPlugins,
 } from '@vitest/pretty-format'
-import { plugins as prettyFormatPlugins } from '@vitest/pretty-format'
+import { plugins as prettyFormatPlugins, PrettyFormatSkipSnapshotError } from '@vitest/pretty-format'
 
 import MockSerializer from './mockSerializer'
 
@@ -39,3 +39,7 @@ export function addSerializer(plugin: PrettyFormatPlugin): void {
 export function getSerializers(): PrettyFormatPlugins {
   return PLUGINS
 }
+
+export function skipSnapshot(): never {
+  throw new PrettyFormatSkipSnapshotError()
+}

packages/snapshot/src/port/state.ts

@@ -17,10 +17,11 @@ import type {
 } from '../types'
 import type { InlineSnapshot } from './inlineSnapshot'
 import type { RawSnapshot, RawSnapshotInfo } from './rawSnapshot'
+import { PrettyFormatSkipSnapshotError } from '@vitest/pretty-format'
 import { parseErrorStacktrace } from '../../../utils/src/source-map'
+
 import { saveInlineSnapshots } from './inlineSnapshot'
 import { saveRawSnapshots } from './rawSnapshot'
-
 import {
   addExtraLineBreaks,
   getSnapshotData,
@@ -250,10 +251,19 @@ export default class SnapshotState {
       this._uncheckedKeys.delete(key)
     }
 
-    let receivedSerialized
-      = rawSnapshot && typeof received === 'string'
-        ? (received as string)
-        : serialize(received, undefined, this._snapshotFormat)
+    let receivedSerialized: string
+    try {
+      receivedSerialized
+        = rawSnapshot && typeof received === 'string'
+          ? (received as string)
+          : serialize(received, undefined, this._snapshotFormat)
+    }
+    catch (e) {
+      if (e instanceof PrettyFormatSkipSnapshotError) {
+        return { pass: true, actual: '', key, count }
+      }
+      throw e
+    }
 
     if (!rawSnapshot) {
       receivedSerialized = addExtraLineBreaks(receivedSerialized)

packages/vitest/src/public/index.ts

@@ -321,6 +321,7 @@ export type {
   SnapshotUpdateState,
   UncheckedSnapshot,
 } from '@vitest/snapshot'
+export { skipSnapshot } from '@vitest/snapshot'
 
 /** @deprecated import from `vitest/node` instead */
 export type BrowserScript = BrowserScript_