Skip to content

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

Open
wants to merge 2 commits into
base: next
Choose a base branch
from

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented May 15, 2025

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:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/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 running npx [email protected] sandbox or in an existing project with npx [email protected] upgrade.

More information
Published version 0.0.0-pr-31489-sha-9a1e0548
Triggered by @yannbf
Repository storybookjs/storybook
Branch yann/support-preview-watch-mode
Commit 9a1e0548
Datetime Thu May 15 13:13:38 UTC 2025 (1747314818)
Workflow run 15045905442

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.

  • Added __STORYBOOK_CONFIG_DIR__ to environment variables in code/addons/vitest/src/vitest-plugin/index.ts
  • Configured forceRerunTriggers to include config directory for automatic test reruns
  • Implemented watch mode filter to ensure tests only rerun for relevant Storybook config directory changes

Copy link
Contributor

@greptile-apps greptile-apps bot left a 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],
Copy link
Contributor

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

Comment on lines +368 to +370
context.vitest.onFilterWatchedSpecification((spec) => {
return spec.project.config.env?.__STORYBOOK_CONFIG_DIR__ === finalOptions.configDir;
});
Copy link
Contributor

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.

Copy link

nx-cloud bot commented May 15, 2025

View your CI Pipeline Execution ↗ for commit 9a1e054.

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 1m 24s View ↗

☁️ Nx Cloud last updated this comment at 2025-05-15 13:20:19 UTC

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants