fix: ignore "plugins" field in snapshotFormat option (vitest-dev#4204)

LorenzoBloedow · Dec 19, 2023 · 702067f · 702067f
1 parent bcf43d3
commit 702067f
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/docs/config/index.md b/docs/config/index.md
@@ -1320,6 +1320,12 @@ Will call [`vi.unstubAllGlobals`](/api/vi#vi-unstuballglobals) before each test.
 
 Format options for snapshot testing. These options are passed down to [`pretty-format`](https://www.npmjs.com/package/pretty-format).
 
+::: tip
+Beware that `plugins` field on this object will be ignored.
+
+If you need to extend snapshot serializer via pretty-format plugins, please, use [`expect.addSnapshotSerializer`](/api/expect#expect-addsnapshotserializer) API.
+:::
+
 ### resolveSnapshotPath<NonProjectOption />
 
 - **Type**: `(testPath: string, snapExtension: string) => string`

diff --git a/packages/vitest/src/node/config.ts b/packages/vitest/src/node/config.ts
@@ -214,6 +214,9 @@ export function resolveConfig(
       : new RegExp(resolved.testNamePattern)
     : undefined
 
+  if (resolved.snapshotFormat && 'plugins' in resolved.snapshotFormat)
+    (resolved.snapshotFormat as any).plugins = []
+
   const UPDATE_SNAPSHOT = resolved.update || process.env.UPDATE_SNAPSHOT
   resolved.snapshotOptions = {
     snapshotFormat: resolved.snapshotFormat || {},

diff --git a/packages/vitest/src/types/config.ts b/packages/vitest/src/types/config.ts
@@ -537,7 +537,7 @@ export interface InlineConfig {
   /**
    * Format options for snapshot testing.
    */
-  snapshotFormat?: PrettyFormatOptions
+  snapshotFormat?: Omit<PrettyFormatOptions, 'plugins'>
 
   /**
    * Path to a module which has a default export of diff config.