feat: support snapshotFormat option (#609)

Author: 9aoy

e2e/snapshot/fixtures/__snapshots__/options.test.ts.snap

@@ -0,0 +1,15 @@
+// Rstest Snapshot v1
+
+exports[`test snapshot > test snapshot generate 1`] = `
+Object {
+  "a": 1,
+  "b": Array [
+    1,
+    2,
+    3,
+  ],
+  "c": Object {
+    "d": "hello",
+  },
+}
+`;

e2e/snapshot/fixtures/options.test.ts

@@ -0,0 +1,13 @@
+import { describe, expect, it } from '@rstest/core';
+
+describe('test snapshot', () => {
+  it('test snapshot generate', () => {
+    expect({
+      a: 1,
+      b: [1, 2, 3],
+      c: {
+        d: 'hello',
+      },
+    }).toMatchSnapshot();
+  });
+});

e2e/snapshot/fixtures/rstest.options.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from '@rstest/core';
+
+export default defineConfig({
+  snapshotFormat: {
+    printBasicPrototype: true,
+  },
+});

e2e/snapshot/options.test.ts

@@ -0,0 +1,26 @@
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { it } from '@rstest/core';
+import { runRstestCli } from '../scripts';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+it('snapshotFormat', async () => {
+  const { expectExecSuccess } = await runRstestCli({
+    command: 'rstest',
+    args: [
+      'run',
+      'fixtures/options.test.ts',
+      '-c',
+      'fixtures/rstest.options.config.ts',
+    ],
+    options: {
+      nodeOptions: {
+        cwd: __dirname,
+      },
+    },
+  });
+
+  await expectExecSuccess();
+});

packages/core/src/config.ts

@@ -144,6 +144,7 @@ const createDefaultConfig = (): NormalizedConfig => ({
   maxConcurrency: 5,
   printConsoleTrace: false,
   disableConsoleIntercept: false,
+  snapshotFormat: {},
   coverage: {
     exclude: [
       '**/node_modules/**',

packages/core/src/pool/index.ts

@@ -51,6 +51,7 @@ const getRuntimeConfig = (context: ProjectContext): RuntimeConfig => {
     hookTimeout,
     isolate,
     coverage,
+    snapshotFormat,
   } = context.normalizedConfig;
 
   return {
@@ -71,6 +72,7 @@ const getRuntimeConfig = (context: ProjectContext): RuntimeConfig => {
     testEnvironment,
     isolate,
     coverage,
+    snapshotFormat,
   };
 };
 

packages/core/src/runtime/worker/index.ts

@@ -46,6 +46,7 @@ const preparePool = async ({
       printConsoleTrace,
       disableConsoleIntercept,
       testEnvironment,
+      snapshotFormat,
     },
   } = context;
 
@@ -66,6 +67,7 @@ const preparePool = async ({
     snapshotOptions: {
       updateSnapshot,
       snapshotEnvironment: new RstestSnapshotEnvironment(),
+      snapshotFormat,
     },
     distPath,
     testPath,

packages/core/src/types/config.ts

@@ -1,4 +1,5 @@
 import type { RsbuildConfig } from '@rsbuild/core';
+import type { SnapshotStateOptions } from '@vitest/snapshot';
 import type { CoverageOptions, NormalizedCoverageOptions } from './coverage';
 import type {
   BuiltInReporterNames,
@@ -24,6 +25,11 @@ export type ProjectConfig = Omit<
   'projects' | 'reporters' | 'pool' | 'isolate' | 'coverage'
 >;
 
+type SnapshotFormat = Omit<
+  NonNullable<SnapshotStateOptions['snapshotFormat']>,
+  'plugins' | 'compareKeys'
+>;
+
 /**
  * A list of glob patterns or files that match your test projects.
  *
@@ -209,6 +215,9 @@ export interface RstestConfig {
    */
   onConsoleLog?: (content: string) => boolean | void;
 
+  /** Format snapshot output */
+  snapshotFormat?: SnapshotFormat;
+
   /**
    * Coverage options
    */

packages/core/src/types/worker.ts

@@ -48,6 +48,7 @@ export type RuntimeConfig = Pick<
   | 'isolate'
   | 'hookTimeout'
   | 'coverage'
+  | 'snapshotFormat'
 >;
 
 export type WorkerContext = {
@@ -77,5 +78,6 @@ export type WorkerState = WorkerContext & {
   snapshotOptions: {
     updateSnapshot: SnapshotUpdateState;
     snapshotEnvironment: SnapshotEnvironment;
+    snapshotFormat: RuntimeConfig['snapshotFormat'];
   };
 };

packages/core/tests/__snapshots__/config.test.ts.snap

@@ -65,6 +65,7 @@ exports[`mergeRstestConfig > should merge config correctly with default config 1
     "./setup.ts",
   ],
   "slowTestThreshold": 300,
+  "snapshotFormat": {},
   "testEnvironment": "node",
   "testTimeout": 5000,
   "unstubEnvs": false,