feat: support resolveSnapshotPath option
#632
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for rstest-dev ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for the resolveSnapshotPath configuration option, allowing users to customize where snapshot files are stored. By default, Rstest saves snapshots in a __snapshots__ folder alongside test files, but this option enables alternative storage strategies like placing snapshots directly next to test files.
- Adds
resolveSnapshotPathconfiguration option to customize snapshot file locations - Updates documentation in both English and Chinese to explain the new option
- Implements the feature with a custom snapshot environment class and RPC integration
Reviewed Changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/core/src/types/config.ts | Adds resolveSnapshotPath type definition to config interface and marks it as optional |
| packages/core/src/types/worker.ts | Extends RuntimeRPC interface with resolveSnapshotPath method |
| packages/core/src/pool/index.ts | Implements default snapshot path resolution logic with fallback to __snapshots__ folder |
| packages/core/src/runtime/worker/snapshot.ts | Extends snapshot environment to support custom path resolution |
| packages/core/src/runtime/worker/index.ts | Integrates custom snapshot path resolver into worker initialization |
| website/theme/components/ConfigOverview.tsx | Adds resolveSnapshotPath to configuration overview list |
| website/docs/en/config/test/resolveSnapshotPath.mdx | Adds English documentation for the new option |
| website/docs/zh/config/test/resolveSnapshotPath.mdx | Adds Chinese documentation for the new option |
| website/docs/en/config/test/_meta.json | Registers new documentation page in English navigation |
| website/docs/zh/config/test/_meta.json | Registers new documentation page in Chinese navigation |
| e2e/snapshot/fixtures/rstest.snapshotPath.config.ts | Adds test configuration demonstrating custom snapshot path usage |
| e2e/snapshot/fixtures/index.test.ts.snap | Adds expected snapshot file for e2e test |
| e2e/snapshot/file.test.ts | Adds e2e test verifying resolveSnapshotPath functionality |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| const resolver = | ||
| context.normalizedConfig.resolveSnapshotPath || | ||
| // test/index.ts -> test/__snapshots__/index.ts.snap | ||
| (() => |
There was a problem hiding this comment.
[nitpick] This arrow function is defined inline but never reused. Consider extracting it to a named function getDefaultSnapshotPath for better readability and testability.
Co-authored-by: Copilot <[email protected]>
Timeless0911
approved these changes
Oct 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
By default, Rstest saves snapshot files in the same directory as the test files, under a
__snapshots__folder.You can use
resolveSnapshotPathto customize this behavior and specify a different location for your snapshot files.For example, store snapshots next to test files:
Related Links
Checklist