-
-
Notifications
You must be signed in to change notification settings - Fork 9.2k
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
CLI: Make PackageJson optional for starting a dev server #28594
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR Summary
code/core/src/core-server/utils/warnWhenUsingArgTypesRegex.ts
: MadepackageJson
parameter optional, addedpreviewConfigPath
.code/core/src/types/modules/core-common.ts
: UpdatedLoadOptions
interface to makepackageJson
optional.
2 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings
☁️ Nx Cloud ReportCI is running/has finished running commands for commit f83fe19. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
… version check) (#722) <!--- ☝️ PR title should follow conventional commits (https://conventionalcommits.org) --> ### 🔗 Linked issue Fixes #704 <!-- If it resolves an open issue, please link the issue here. For example "Resolves #123" --> ### ❓ Type of change <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply. --> - [ ] 📖 Documentation (updates to the documentation or readme) - [ ] 🐞 Bug fix (a non-breaking change that fixes an issue) - [ ] 👌 Enhancement (improving an existing functionality) - [ ] ✨ New feature (a non-breaking change that adds functionality) - [ ] 🧹 Chore (updates to the build process or auxiliary tools and libraries) - [ ]⚠️ Breaking change (fix or feature that would cause existing functionality to change) ### 📚 Description Instead of actually loading the package json, we just pass a javascript object with a `version` field. That is the only thing used by storybook. It's a temporary workaround until storybookjs/storybook#28594 is merged. <!-- Describe your changes in detail --> <!-- Why is this change required? What problem does it solve? -->
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@tobiasdiez, it appears that one of the changed values has string|null
type instead of expected string|undefined
, and this makes the build fail in CircleCI:
src/core-server/build-dev.ts(50,5): error TS2322: Type 'string | null' is not assignable to type 'string | undefined'.
Type 'null' is not assignable to type 'string | undefined'.
``
Co-authored-by: Olga Bulat <obulat@gmail.com>
What I did
Currently, starting the storybook dev sever operates with the following assumptions:
storybook
scripts to run storybookFor the nuxt integration both assumptions may not be fullfilled: the storybook packages are dependencies of the nuxt module but not of the project where they are installed. And the dev server may be started as part of the nuxt dev server.
Hence the interface for the
buildDevStandalone
is changed to makepackageJson
optional. This would also help fixing the downstream issue nuxt-modules/storybook#704Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
I couldn't test this manually due to #28593
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/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>