feat: support resolveSnapshotPath option (#632)

Co-authored-by: Copilot <[email protected]>

Author: 9aoy

e2e/snapshot/file.test.ts

@@ -29,7 +29,6 @@ describe('test snapshot', () => {
     });
 
     await expectFile(snapshotFilePath, 3000);
-    expect(fs.existsSync(snapshotFilePath)).toBeTruthy();
 
     // should generator snapshot name correctly
     await expect
@@ -41,6 +40,33 @@ describe('test snapshot', () => {
     fs.rmSync(snapshotFilePath);
   });
 
+  it('resolveSnapshotPath', async () => {
+    const snapshotFilePath = join(__dirname, 'fixtures/index.test.ts.snap');
+
+    fs.rmSync(snapshotFilePath, {
+      force: true,
+    });
+    const { expectExecSuccess } = await runRstestCli({
+      command: 'rstest',
+      args: [
+        'run',
+        'fixtures/index.test.ts',
+        '-u',
+        '-c',
+        'fixtures/rstest.snapshotPath.config.ts',
+      ],
+      options: {
+        nodeOptions: {
+          cwd: __dirname,
+        },
+      },
+    });
+
+    await expectExecSuccess();
+
+    await expectFile(snapshotFilePath, 3000);
+  });
+
   describe('test snapshot file state', () => {
     it('test toMatchSnapshot API', () => {
       expect('hello world').toMatchSnapshot();

e2e/snapshot/fixtures/index.test.ts.snap

@@ -0,0 +1,3 @@
+// Rstest Snapshot v1
+
+exports[`test snapshot > test snapshot generate 1`] = `"hello world"`;

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

@@ -0,0 +1,6 @@
+import { defineConfig } from '@rstest/core';
+
+export default defineConfig({
+  resolveSnapshotPath: (testPath, snapshotExtension) =>
+    testPath + snapshotExtension,
+});

packages/core/src/pool/index.ts

@@ -1,5 +1,6 @@
 import os from 'node:os';
 import type { SnapshotUpdateState } from '@vitest/snapshot';
+import { basename, dirname, join } from 'pathe';
 import type {
   EntryInfo,
   FormattedError,
@@ -208,6 +209,21 @@ export const createPool = async ({
         reporters.map((reporter) => reporter.onTestFileStart?.(test)),
       );
     },
+    resolveSnapshotPath: (testPath: string): string => {
+      const snapExtension = '.snap';
+      const resolver =
+        context.normalizedConfig.resolveSnapshotPath ||
+        // test/index.ts -> test/__snapshots__/index.ts.snap
+        (() =>
+          join(
+            dirname(testPath),
+            '__snapshots__',
+            `${basename(testPath)}${snapExtension}`,
+          ));
+
+      const snapshotPath = resolver(testPath, snapExtension);
+      return snapshotPath;
+    },
   };
 
   return {

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

@@ -90,7 +90,10 @@ const preparePool = async ({
     ...context,
     snapshotOptions: {
       updateSnapshot,
-      snapshotEnvironment: new RstestSnapshotEnvironment(),
+      snapshotEnvironment: new RstestSnapshotEnvironment({
+        resolveSnapshotPath: (filepath: string) =>
+          rpc.resolveSnapshotPath(filepath),
+      }),
       snapshotFormat,
     },
     distPath,

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

@@ -1,7 +1,20 @@
 import { NodeSnapshotEnvironment } from '@vitest/snapshot/environment';
 
 export class RstestSnapshotEnvironment extends NodeSnapshotEnvironment {
+  private resolveSnapshotPath: (filepath: string) => Promise<string>;
+
+  constructor(options: {
+    resolveSnapshotPath: (filepath: string) => Promise<string>;
+  }) {
+    super();
+    this.resolveSnapshotPath = options.resolveSnapshotPath;
+  }
+
   override getHeader(): string {
     return `// Rstest Snapshot v${this.getVersion()}`;
   }
+
+  override resolvePath(filepath: string): Promise<string> {
+    return this.resolveSnapshotPath(filepath);
+  }
 }

packages/core/src/types/config.ts

@@ -224,6 +224,11 @@ export interface RstestConfig {
   /** Format snapshot output */
   snapshotFormat?: SnapshotFormat;
 
+  /**
+   * Resolve custom snapshot path
+   */
+  resolveSnapshotPath?: (testPath: string, snapExtension: string) => string;
+
   /**
    * Custom environment variables available on `process.env` during tests.
    */
@@ -272,7 +277,8 @@ type OptionalKeys =
   | 'performance'
   | 'tools'
   | 'dev'
-  | 'onConsoleLog';
+  | 'onConsoleLog'
+  | 'resolveSnapshotPath';
 
 export type NormalizedConfig = Required<
   Omit<

packages/core/src/types/worker.ts

@@ -24,6 +24,7 @@ export type RuntimeRPC = {
   }>;
   onTestCaseResult: (result: TestResult) => Promise<void>;
   onConsoleLog: (log: UserConsoleLog) => void;
+  resolveSnapshotPath: (filepath: string) => string;
 };
 
 export type RuntimeConfig = Pick<

website/docs/en/config/test/_meta.json

@@ -32,6 +32,7 @@
   "hideSkippedTests",
   "slowTestThreshold",
   "snapshotFormat",
+  "resolveSnapshotPath",
   "printConsoleTrace",
   "onConsoleLog",
   "disableConsoleIntercept"

website/docs/en/config/test/resolveSnapshotPath.mdx

@@ -0,0 +1,21 @@
+# resolveSnapshotPath
+
+- **Type:** `(testPath: string, snapExtension: string) => string`
+- **Default:** `undefined`
+
+Custom handler for resolving snapshot paths in tests.
+
+By default, Rstest saves snapshot files in the same directory as the test files, under a `__snapshots__` folder.
+
+You can use `resolveSnapshotPath` to customize this behavior and specify a different location for your snapshot files.
+
+For example, store snapshots next to test files:
+
+```ts title="rstest.config.ts"
+import { defineConfig } from '@rstest/core';
+
+export default defineConfig({
+  resolveSnapshotPath: (testPath, snapshotExtension) =>
+    testPath + snapshotExtension,
+});
+```