Addon Vitest: Support init in Vitest >= 3.2 by valentinpalkovic · Pull Request #31715 · storybookjs/storybook

valentinpalkovic · 2025-06-10T06:11:05Z

Closes #31689

What I did

Use the projects field when initializing Addon Vitest for Vitest 3.2 users
Added optimizeDeps to @storybook/addon-vitest
Fixed a bug where some preview annotations weren't added for Next.js
Refactored the vitest config override for our sandboxes so that we only apply small changes instead of overriding the whole config

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-31715-sha-b9a0ceb9. Try it out in a new sandbox by running npx storybook@0.0.0-pr-31715-sha-b9a0ceb9 sandbox or in an existing project with npx storybook@0.0.0-pr-31715-sha-b9a0ceb9 upgrade.

More information


Published version	`0.0.0-pr-31715-sha-b9a0ceb9`
Triggered by	@valentinpalkovic
Repository	storybookjs/storybook
Branch	`valentin/support-vitest-3-2`
Commit	`b9a0ceb9`
Datetime	Fri Jun 13 14:07:41 UTC 2025 (`1749823661`)
Workflow run	15636541237

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=31715

Greptile Summary

Updates the Vitest addon to support Vitest >= 3.2 by using the projects field instead of the deprecated workspace file configuration.

Added new template vitest.config.3.2.template.ts utilizing the projects array instead of workspace config
Updated postinstall script to detect Vitest version and apply appropriate configuration template
Modified config file updater to handle both legacy workspace and new projects field formats
Updated dependencies to support Vitest ^3.2.0 while maintaining backward compatibility
Added comprehensive documentation explaining configuration differences between Vitest versions

nx-cloud · 2025-06-10T06:17:44Z

View your CI Pipeline Execution ↗ for commit 29b367b.

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

☁️ Nx Cloud last updated this comment at 2025-06-16 12:44:25 UTC

…st-3-2

greptile-apps

_{7 files reviewed, 4 comments}
_{Edit PR Review Bot Settings | Greptile}

greptile-apps · 2025-06-13T10:53:01Z

+      // Use `workspace` field in Vitest < 3.2
+      projects: [{


syntax: Comment implies this field should be used for Vitest < 3.2, but it's actually for >= 3.2. Update comment to avoid confusion.

greptile-apps · 2025-06-13T10:53:01Z

+      // Use `workspace` field in Vitest < 3.2
+      projects: [{


syntax: Same incorrect comment about Vitest version compatibility in Vue template.

greptile-apps · 2025-06-13T10:53:02Z

+      // Use `workspace` field in Vitest < 3.2
+      projects: [{


syntax: Same incorrect comment about Vitest version compatibility in Svelte template.

greptile-apps · 2025-06-13T10:53:05Z

    const hasWorkspaceConfig = configFile.includes('workspace:');
+    const hasProjectsConfig = configFile.includes('projects:');
+    const configFileHasTypeReference = configFile.match(
+      /\/\/\/\s*<reference\s+types=["']vitest\/config["']\s*\/>/
+    );


logic: ensure both workspace: and projects: checks are using strict string matching (e.g., /\bworkspace:\b/.test(configFile)) to avoid false positives

storybook-app-bot · 2025-06-13T14:12:55Z

Package Benchmarks

^{Commit: 29b367b, ran on 16 June 2025 at 12:50:06 UTC}

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

`storybook`

	Before	After	Difference
Dependency count	49	49	0
Self size	31.85 MB	31.87 MB	🚨 +16 KB 🚨
Dependency size	17.41 MB	17.41 MB	0 B
Bundle Size Analyzer	Link	Link

`@storybook/nextjs`

	Before	After	Difference
Dependency count	531	531	0
Self size	217 KB	902 KB	🚨 +686 KB 🚨
Dependency size	58.92 MB	58.92 MB	🚨 +172 B 🚨
Bundle Size Analyzer	Link	Link

`@storybook/nextjs-vite`

	Before	After	Difference
Dependency count	131	131	0
Self size	2.39 MB	3.07 MB	🚨 +685 KB 🚨
Dependency size	22.30 MB	22.30 MB	🚨 +500 B 🚨
Bundle Size Analyzer	Link	Link

`sb`

	Before	After	Difference
Dependency count	50	50	0
Self size	1 KB	1 KB	0 B
Dependency size	49.26 MB	49.27 MB	🚨 +16 KB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/cli`

	Before	After	Difference
Dependency count	216	216	0
Self size	582 KB	582 KB	0 B
Dependency size	94.58 MB	94.59 MB	🚨 +16 KB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/codemod`

	Before	After	Difference
Dependency count	185	185	0
Self size	31 KB	31 KB	0 B
Dependency size	78.71 MB	78.72 MB	🚨 +16 KB 🚨
Bundle Size Analyzer	Link	Link

… dependency order

…Vitest and load optimizeDeps preset

…Candidates for optimized resolution

…S and streamline dependency resolution

…hancing compatibility with plugins

JReinhold · 2025-06-16T12:45:24Z

-
-      const extension = extname(rootConfig).includes('ts') ? '.ts' : '.js';
-      const newWorkspaceFile = resolve(dirname(rootConfig), `vitest.workspace${extension}`);
-      const workspaceTemplate = await loadTemplate('vitest.workspace.template.ts', {


should the vitest.workspace.template.ts file be deleted then, or is it still being used somewhere?

It is still used in the case the user has an existing workspace file.

JReinhold · 2025-06-16T12:51:37Z


 <details id="example-vitest-workspace">
-  <summary>Example Vitest workspace file</summary>
+  <summary>Example Vitest workspace file (Vitest < 3.2)</summary>


I'd think it makes more sense to remove this section altogether, now that the example config file already has everything, including pre and post Vitest 3.2?

And also adjust https://github.com/storybookjs/storybook/pull/31715/files#diff-64c8d1c5581a216a909dc8ece0c8611404e6add0ec5d6f9faecdec6ae300dbbeR66 to not mention a separate worksapce file.

cc @kylegach

That's what I wanted to do initially, but @yannbf vetoed and wanted to keep the documentation for people who already have a workspace configuration in place.

Addon Vitest: Support init in Vitest >= 3.2 (cherry picked from commit 1cce824)

vanessayuenn mentioned this pull request Jun 11, 2025

[Bug]: Storybook cannot resolve MDX when storybookTest plugin is in vite.config.ts #31676

Closed

Support Vitest 3.2

af7fb1b

valentinpalkovic force-pushed the valentin/support-vitest-3-2 branch from 6cab441 to af7fb1b Compare June 13, 2025 09:50

Merge remote-tracking branch 'origin/next' into valentin/support-vite…

e505cea

…st-3-2

valentinpalkovic added bug ci:normal labels Jun 13, 2025

valentinpalkovic self-assigned this Jun 13, 2025

valentinpalkovic added the addon: vitest label Jun 13, 2025

valentinpalkovic changed the title ~~WIP: Addon Vitest: Support init in Vitest >= 3.2~~ Addon Vitest: Support init in Vitest >= 3.2 Jun 13, 2025

Update Vitest 3.2

fe72417

valentinpalkovic marked this pull request as ready for review June 13, 2025 10:52

valentinpalkovic requested review from jonniebigodes and kylegach as code owners June 13, 2025 10:52

greptile-apps Bot reviewed Jun 13, 2025

View reviewed changes

Refactor post-install script for improved error handling and logging

b9a0ceb

valentinpalkovic added 6 commits June 16, 2025 08:21

Update optimizeDeps.ts to include additional Storybook addons and fix…

22d796f

… dependency order

Simplify vitest sandbox generation

da0e6f4

Add INCLUDE_CANDIDATES constant for optimized dependency handling in …

5730da9

…Vitest and load optimizeDeps preset

Refactor dependency handling in Vitest to use filterResolvableInclude…

f6d611f

…Candidates for optimized resolution

Refactor optimizeDeps handling in Vitest to include INCLUDE_CANDIDATE…

af59deb

…S and streamline dependency resolution

Insert resolve configuration in Vitest setup to preserve symlinks, en…

d176c8e

…hancing compatibility with plugins

valentinpalkovic commented Jun 16, 2025

View reviewed changes

Comment thread code/builders/builder-vite/src/constants.ts Outdated

valentinpalkovic added 3 commits June 16, 2025 11:17

Update code/builders/builder-vite/src/constants.ts

b35fbf8

Remove filterResolvableIncludeCandidates

2d18cac

Refactor INTERNAL_DEFAULT_PROJECT_ANNOTATIONS

9ee5451

valentinpalkovic requested a review from JReinhold June 16, 2025 11:02

Merge branch 'next' into valentin/support-vitest-3-2

29b367b

JReinhold approved these changes Jun 16, 2025

View reviewed changes

valentinpalkovic merged commit 1cce824 into next Jun 16, 2025
56 of 57 checks passed

valentinpalkovic deleted the valentin/support-vitest-3-2 branch June 16, 2025 12:58

github-actions Bot mentioned this pull request Jun 16, 2025

Release: Prerelease 9.1.0-alpha.7 #31748

Merged

71 tasks

valentinpalkovic added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Jun 17, 2025

github-actions Bot mentioned this pull request Jun 17, 2025

Release: Patch 9.0.12 #31801

Merged

15 tasks

valentinpalkovic added a commit that referenced this pull request Jun 17, 2025

Merge pull request #31715 from storybookjs/valentin/support-vitest-3-2

a834932

Addon Vitest: Support init in Vitest >= 3.2 (cherry picked from commit 1cce824)

github-actions Bot mentioned this pull request Jun 18, 2025

Release: Patch 9.0.12 #31810

Closed

15 tasks

github-actions Bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Jun 18, 2025

dosubot Bot mentioned this pull request Jun 30, 2025

[Bug]: Storybook Test with Svelte fails in Windows #31901

Open

github-actions Bot mentioned this pull request Aug 13, 2025

[master] Michijs Dependabot changes michijs/michijs-storybook-template#68

Closed

ndelangen removed the patch:yes Bugfix & documentation PR that need to be picked to main branch label Oct 28, 2025

ashleeradka mentioned this pull request May 19, 2026

fix(design-library): use @playwright/browser-chromium for declarative browser setup vellum-ai/vellum-assistant#31205

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Addon Vitest: Support init in Vitest >= 3.2#31715

Addon Vitest: Support init in Vitest >= 3.2#31715
valentinpalkovic merged 14 commits into
nextfrom
valentin/support-vitest-3-2

valentinpalkovic commented Jun 10, 2025 •

edited

Loading

Uh oh!

nx-cloud Bot commented Jun 10, 2025 •

edited

Loading

Uh oh!

greptile-apps Bot left a comment

Uh oh!

greptile-apps Bot Jun 13, 2025

Uh oh!

greptile-apps Bot Jun 13, 2025

Uh oh!

greptile-apps Bot Jun 13, 2025

Uh oh!

greptile-apps Bot Jun 13, 2025

Uh oh!

storybook-app-bot Bot commented Jun 13, 2025 •

edited

Loading

Uh oh!

Uh oh!

JReinhold Jun 16, 2025

Uh oh!

valentinpalkovic Jun 16, 2025

Uh oh!

JReinhold Jun 16, 2025

Uh oh!

valentinpalkovic Jun 16, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

valentinpalkovic commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What I did

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

Manual testing

Documentation

Checklist for Maintainers

🦋 Canary release

Greptile Summary

Uh oh!

nx-cloud Bot commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

greptile-apps Bot left a comment

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps Bot Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

storybook-app-bot Bot commented Jun 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Package Benchmarks

storybook

@storybook/nextjs

@storybook/nextjs-vite

sb

@storybook/cli

@storybook/codemod

Uh oh!

Uh oh!

JReinhold Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

valentinpalkovic Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

JReinhold Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

valentinpalkovic Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

valentinpalkovic commented Jun 10, 2025 •

edited

Loading

nx-cloud Bot commented Jun 10, 2025 •

edited

Loading

storybook-app-bot Bot commented Jun 13, 2025 •

edited

Loading

`storybook`

`@storybook/nextjs`

`@storybook/nextjs-vite`

`sb`

`@storybook/cli`

`@storybook/codemod`