Skip to content

Addon Vitest: Fix watch mode for new files #31156

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

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

Conversation

valentinpalkovic
Copy link
Contributor

@valentinpalkovic valentinpalkovic commented Apr 17, 2025

Closes #31100

What I did

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 PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

Greptile Summary

This PR improves file watching functionality in the Storybook Vitest addon, particularly focusing on proper detection and testing of newly added files.

  • Added explicit file event handling in vitest-manager.ts to distinguish between 'add' and 'change' events
  • Introduced matchesTestGlob call in runAffectedTestsAfterChange to properly register new test files
  • Replaced tinyglobby with micromatch for more reliable file pattern matching
  • Added includeStories to InternalOptions for better control over story inclusion
  • Exported DEFAULT_FILES_PATTERN from normalize-stories for consistent file matching across the codebase

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.

5 file(s) reviewed, 3 comment(s)
Edit PR Review Bot Settings | Greptile

Comment on lines 376 to 377
// This function not onlye test a file matches the test globs, but it also
// adds the file to the project's internal testFilesList
Copy link
Contributor

Choose a reason for hiding this comment

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

syntax: typo in comment: 'onlye' should be 'only'

Suggested change
// This function not onlye test a file matches the test globs, but it also
// adds the file to the project's internal testFilesList
// This function not only test a file matches the test globs, but it also
// adds the file to the project's internal testFilesList

Comment on lines 32 to 36
export type InternalOptions = Required<UserOptions> & {
debug: boolean;
tags: Required<UserOptions['tags']>;
includeStories: string[];
};
Copy link
Contributor

Choose a reason for hiding this comment

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

style: Consider documenting the includeStories property with JSDoc like the other properties


return relativeToViteRoot;
})
.filter((story) => story.replace('mdx|stories', 'stories'));
Copy link
Contributor

Choose a reason for hiding this comment

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

logic: The replace call here won't work as intended - it only replaces the first occurrence and returns a new string without modifying the original. Should use a regex with global flag: /mdx|stories/g

Suggested change
.filter((story) => story.replace('mdx|stories', 'stories'));
.filter((story) => story.replace(/mdx|stories/g, 'stories'));

Copy link

nx-cloud bot commented Apr 17, 2025

View your CI Pipeline Execution ↗ for commit da2f21a.

Command Status Duration Result
nx affected -t check -c production --parallel=7 ✅ Succeeded <1s View ↗
nx run-many -t build -c production --parallel=3 ✅ Succeeded 2s View ↗

☁️ Nx Cloud last updated this comment at 2025-04-17 22:17:49 UTC

@yannbf yannbf changed the title WIP: Fix watch mode for new files Addon Vitest: Fix watch mode for new files Apr 17, 2025
@valentinpalkovic valentinpalkovic marked this pull request as draft April 17, 2025 22:16
Copy link
Contributor

Fails
🚫 PR is marked with "ci: do not merge" label.

Generated by 🚫 dangerJS against da2f21a

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.

[Bug]: Storybook 9 - Storybook test does not detect newly added story file
2 participants