Skip to content

Addon Vitest: Ensure vitest exclusions are relative to the project root, not cwd #31514

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

Merged
merged 2 commits into from
May 20, 2025

Conversation

mrginglymus
Copy link
Contributor

@mrginglymus mrginglymus commented May 19, 2025

Closes #31500

What I did

If you keep all your config in your ./.storybook directory, then your test patterns will likely be something like:

["../stories/**/*.stories.ts", "../stories/**/*.mdx"]

By default, addon-vitest only adds an ignore pattern of **/*.mdx, which does not match the patterns above.

This change ensures that the mdx exclusion glob is relative to the project root directory rather than cwd, to match the inclusion globs.

More refinement and testing required, I just thought of this on the way to bed.

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

Modified Vitest plugin to fix MDX file exclusion patterns by making them relative to the project root instead of the current working directory, addressing test file discovery issues.

  • Updated path handling in code/addons/vitest/src/vitest-plugin/index.ts to use join(relative(root, process.cwd()), '**/*.mdx') for correct MDX exclusion
  • Added sep import from pathe for cross-platform path separator handling
  • Normalized path separators using replaceAll(sep, '/')

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, 1 comment(s)
Edit PR Review Bot Settings | Greptile

Copy link

nx-cloud bot commented May 19, 2025

View your CI Pipeline Execution ↗ for commit f67d4ce.

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

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

@storybook-pr-benchmarking
Copy link

storybook-pr-benchmarking bot commented May 20, 2025

Package Benchmarks

Commit: f67d4ce, ran on 20 May 2025 at 10:05:26 UTC

The following packages have significant changes to their size or dependencies:

@storybook/nextjs

Before After Difference
Dependency count 534 534 0
Self size 216 KB 216 KB 0 B
Dependency size 58.69 MB 58.76 MB 🚨 +75 KB 🚨
Bundle Size Analyzer Link Link

@storybook/nextjs-vite

Before After Difference
Dependency count 127 127 0
Self size 2.39 MB 2.39 MB 0 B
Dependency size 22.05 MB 22.13 MB 🚨 +75 KB 🚨
Bundle Size Analyzer Link Link

@storybook/react-native-web-vite

Before After Difference
Dependency count 160 160 0
Self size 35 KB 35 KB 🚨 +129 B 🚨
Dependency size 23.19 MB 23.26 MB 🚨 +75 KB 🚨
Bundle Size Analyzer Link Link

@storybook/react-vite

Before After Difference
Dependency count 120 120 0
Self size 32 KB 32 KB 0 B
Dependency size 20.16 MB 20.23 MB 🚨 +75 KB 🚨
Bundle Size Analyzer Link Link

@storybook/react-webpack5

Before After Difference
Dependency count 284 284 0
Self size 25 KB 25 KB 0 B
Dependency size 43.48 MB 43.56 MB 🚨 +75 KB 🚨
Bundle Size Analyzer Link Link

@storybook/react

Before After Difference
Dependency count 2 2 0
Self size 1.66 MB 1.73 MB 🚨 +75 KB 🚨
Dependency size 16 KB 16 KB 0 B
Bundle Size Analyzer Link Link

@valentinpalkovic
Copy link
Contributor

LGTM! Thanks @mrginglymus

@valentinpalkovic valentinpalkovic merged commit 8c393ef into storybookjs:next May 20, 2025
53 checks passed
@github-actions github-actions bot mentioned this pull request May 20, 2025
10 tasks
@mrginglymus mrginglymus deleted the mdx-glob branch May 20, 2025 16:05
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]: no test files found since 9.0.0-rc.2
2 participants