Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(snapshot): provide config to resolveSnapshotPath #6800

Merged
merged 13 commits into from
Nov 13, 2024

Conversation

hi-ogawa
Copy link
Contributor

@hi-ogawa hi-ogawa commented Oct 28, 2024

Description

Currently call flow looks like this:

SnapshotState.create
  -> VitestNodeSnapshotEnvironment.resolvePath(path)
  -> RuntimeRPC.resolveSnapshotPath(path)
  -> SnapshotManager.resolvePath(path, context)
  -> SnapshotStateOptions.resolveSnapshotPath(path, extension, context)

Context is technically not snapshot package level concern, but in order to pass it through, I changed SnapshotManager. Probably there is a different way to achieve something similar without changing SnapshotManager, but I think this works for now. Bigger structural change would be required later anyways for #1620.

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. If the feature is substantial or introduces breaking changes without a discussion, PR might be closed.
  • Ideally, include a test that fails without this PR but passes with it.
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Tests

  • Run the tests with pnpm test:ci.

Documentation

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs command.

Changesets

  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

Copy link

netlify bot commented Oct 28, 2024

Deploy Preview for vitest-dev ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 63ea057
🔍 Latest deploy log https://app.netlify.com/sites/vitest-dev/deploys/67219a83a785410008e62915
😎 Deploy Preview https://deploy-preview-6800--vitest-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@hi-ogawa hi-ogawa marked this pull request as ready for review October 28, 2024 10:21
@@ -573,7 +574,11 @@ export interface InlineConfig {
/**
* Resolve custom snapshot path
*/
resolveSnapshotPath?: (path: string, extension: string) => string
resolveSnapshotPath?: (
Copy link
Member

@sheremet-va sheremet-va Oct 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we also expose a type from vitest/node? Maybe ResolveSnapshotPathHandler?

@sheremet-va
Copy link
Member

sheremet-va commented Oct 28, 2024

feat(vitest,snapshot)

Can we keep a single scope? Several scopes just make it harder to parse release notes. "vitest" is kind of redundant. The scope is not about the package

@hi-ogawa hi-ogawa changed the title feat(vitest,snapshot): provide config to resolveSnapshotPath feat(snapshot): provide config to resolveSnapshotPath Oct 29, 2024
@sheremet-va sheremet-va added this to the 2.2.0 milestone Oct 30, 2024
@sheremet-va sheremet-va merged commit 746d898 into vitest-dev:main Nov 13, 2024
17 checks passed
@hi-ogawa hi-ogawa deleted the feat-resolveSnapshotPath-context branch November 13, 2024 23:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

resolveSnapshotPath to provide project root
2 participants