-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
Addon Vitest: Trigger tests on preview file changes in watch mode #31489
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
base: next
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1 file(s) reviewed, 2 comment(s)
Edit PR Review Bot Settings | Greptile
|
||
VITEST_STORYBOOK: vitestStorybook, | ||
__VITEST_INCLUDE_TAGS__: finalOptions.tags.include.join(','), | ||
__VITEST_EXCLUDE_TAGS__: finalOptions.tags.exclude.join(','), | ||
__VITEST_SKIP_TAGS__: finalOptions.tags.skip.join(','), | ||
}, | ||
|
||
forceRerunTriggers: [finalOptions.configDir], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
style: forceRerunTriggers should include preview.{js,ts} specifically rather than the entire config directory to avoid unnecessary reruns
context.vitest.onFilterWatchedSpecification((spec) => { | ||
return spec.project.config.env?.__STORYBOOK_CONFIG_DIR__ === finalOptions.configDir; | ||
}); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
logic: This filter could cause issues in multi-project setups where multiple Storybook instances share the same Vitest config. Consider adding additional project-specific identifiers.
View your CI Pipeline Execution ↗ for commit 9a1e054.
☁️ Nx Cloud last updated this comment at |
Closes #
What I did
The Vitest addon will now trigger all tests in watch mode when the preview.js file is changed, when running in the CLI!
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.ts
Make sure this PR contains one of the labels below:
Available labels
bug
: Internal changes that fixes incorrect behavior.maintenance
: User-facing maintenance tasks.dependencies
: Upgrading (sometimes downgrading) dependencies.build
: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup
: Minor cleanup style change. Will not show up in release changelog.documentation
: Documentation only changes. Will not show up in release changelog.feature request
: Introducing a new feature.BREAKING CHANGE
: Changes that break compatibility in some way with current major version.other
: Changes that don't fit in the above categories.🦋 Canary release
This pull request has been released as version
0.0.0-pr-31489-sha-9a1e0548
. Try it out in a new sandbox by runningnpx [email protected] sandbox
or in an existing project withnpx [email protected] upgrade
.More information
0.0.0-pr-31489-sha-9a1e0548
yann/support-preview-watch-mode
9a1e0548
1747314818
)To request a new release of this pull request, mention the
@storybookjs/core
team.core team members can create a new canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=31489
Greptile Summary
Enhanced Vitest addon to trigger test reruns when preview files change in watch mode, improving development workflow for Storybook configurations.
__STORYBOOK_CONFIG_DIR__
to environment variables incode/addons/vitest/src/vitest-plugin/index.ts
forceRerunTriggers
to include config directory for automatic test reruns