-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
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: Add more information to storybook info
command
#24003
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.
LGTM!
I think it would be nice if we also added npmGlobalPackages
for @storybook/cli + storybook, since we do not want people to install them globally and users in the past had issues because they had an incredibly outdated global version of the cli.
It would also be nice to get the "active" package manager, because even though we get the binaries, we don't know whether the project they're in is actually using yarn/npm/pnpm.
We do, I just didn't have that installed, I've updated the example. this only works for npm though, not for Yarn1 or pnpm.
great idea, I implemented that and updated the example output in the description. |
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.
Awesome!!
What I did
Expanded the information we're looking for when running
storybook info
. Most importantly we now also get information about thestorybook
CLI package.We could also expand the list even further to include all major UI frameworks?
Here's the current output from a project:
Here's the output with these changes (diffs mine):
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
yarn build cli
from within thecode
directorycd
to a separate project of yours<PATH_TO_YOUR_STORYBOOK_REPOSITORY>/code/lib/cli/bin/index.js info
Documentation
We might have examples of this output somewhere, that we want to update as well
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>