Addon-vitest: Fix adding with --skip-install failing missing packageJson invariant
#31720
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
View your CI Pipeline Execution ↗ for commit 24fbaa4.
☁️ Nx Cloud last updated this comment at |
JReinhold
changed the title
--skip-install failing missing packageJson invariant
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR addresses a bug where running packageManager.addDependencies() with --skip-install failed due to a missing packageJson parameter.
- Enforces that packageJson is passed when skipInstall is true via a union type in addDependencies.
- Updates the postinstall script for addon-vitest to supply the packageJson by invoking readPackageJson().
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| code/core/src/common/js-package-manager/JsPackageManager.ts | Refactored addDependencies signature to enforce packageJson with skipInstall. |
| code/addons/vitest/src/postinstall.ts | Updated addDependencies call to include packageJson read from the file system. |
Comments suppressed due to low confidence (1)
code/core/src/common/js-package-manager/JsPackageManager.ts:256
- [nitpick] Since the new union type in the method signature guarantees that packageJson is provided when skipInstall is true, consider removing the redundant runtime invariant check for packageJson or adding a comment explaining its necessity for extra safety.
invariant(packageJson, 'Missing packageJson.');
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
LGTM
3 files reviewed, no comments
Edit PR Review Bot Settings | Greptile
Package BenchmarksCommit: The following packages have significant changes to their size or dependencies:
|
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 49 | 49 | 0 |
| Self size | 31.22 MB | 31.40 MB | 🚨 +185 KB 🚨 |
| Dependency size | 17.41 MB | 17.41 MB | 0 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 | 48.63 MB | 48.81 MB | 🚨 +185 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/cli
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 324 | 324 | 0 |
| Self size | 244 KB | 244 KB | 🚨 +188 B 🚨 |
| Dependency size | 98.82 MB | 97.90 MB | 🎉 -921 KB 🎉 |
| Bundle Size Analyzer | Link | Link |
@storybook/codemod
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 267 | 267 | 0 |
| Self size | 31 KB | 31 KB | 0 B |
| Dependency size | 82.11 MB | 82.29 MB | 🚨 +185 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
create-storybook
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 1 | 1 | 0 |
| Self size | 12.13 MB | 11.02 MB | 🎉 -1.11 MB 🎉 |
| Dependency size | 98 KB | 98 KB | 0 B |
| Bundle Size Analyzer | Link | Link |
yannbf
approved these changes
Jun 10, 2025
JReinhold
added
the
patch:yes
Contributor
There was a problem hiding this comment.
LGTM
3 files reviewed, no comments
Edit PR Review Bot Settings | Greptile
This was referenced Jun 10, 2025
Closed
Merged
JReinhold
added a commit
that referenced
this pull request
Jun 10, 2025
…pinstall Addon-vitest: Fix adding with `--skip-install` failing missing packageJson invariant (cherry picked from commit 505b08f)
github-actions
bot
added
the
patch:done
Contributor
There was a problem hiding this comment.
LGTM
3 files reviewed, no comments
Edit PR Review Bot Settings | Greptile
This was referenced Aug 18, 2025
ndelangen
removed
the
patch:yes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What I did
Follow-up to #31605
This fixes a bug, that running
packageManager.addDependencies()withskipInstall: truerequired that you also passpackageJson, which the postinstall script from addon-vitest did not.An alternative solution would be that
JsPackageManageritself read the package.json (this.readPackageJson()) if it was not passed, but it was unclear to me whether that would work in all instances or not.This bug is currently blocking the installation of addon-vitest with the
sv(Svelte) CLI because that always runs with--skip-install.Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
node_modules,package-lock.json, withoutvitestinstalled and without the addon installed, runnpx storybook@latest add @storybook/addon-vitest --skip-installnpx [email protected] add @storybook/addon-vitest --skip-installDocumentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH 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.tsMake 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-31720-sha-0f081578. Try it out in a new sandbox by runningnpx [email protected] sandboxor in an existing project withnpx [email protected] upgrade.More information
0.0.0-pr-31720-sha-0f081578jeppe/fix-addon-vitest-skipinstall0f0815781749545268)To request a new release of this pull request, mention the
@storybookjs/coreteam.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=31720Greptile Summary
Fixes a critical bug in
@storybook/addon-vitestwhere installation fails with--skip-installflag due to missingpackageJsonrequirement.code/addons/vitest/src/postinstall.tsto explicitly include requiredpackageJsonparameter inaddDependenciescallsJsPackageManager.tsto enforcepackageJsonparameter whenskipInstall: true--skip-install