Skip to content
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

Merged
merged 3 commits into from
Aug 30, 2023

Conversation

JReinhold
Copy link
Contributor

@JReinhold JReinhold commented Aug 30, 2023

What I did

Expanded the information we're looking for when running storybook info. Most importantly we now also get information about the storybook CLI package.

We could also expand the list even further to include all major UI frameworks?

Here's the current output from a project:

Environment Info:

  System:
    OS: macOS 13.1
    CPU: (10) arm64 Apple M1 Pro
  Binaries:
    Node: 16.19.1 - ~/.nvm/versions/node/v16.19.1/bin/node
    Yarn: 1.22.19 - ~/.nvm/versions/node/v16.19.1/bin/yarn
    npm: 8.19.3 - ~/.nvm/versions/node/v16.19.1/bin/npm
  Browsers:
    Chrome: 116.0.5845.110
    Safari: 16.2
  npmPackages:
    @storybook/addon-essentials: ^7.3.2 => 7.3.2
    @storybook/addon-interactions: ^7.3.2 => 7.3.2
    @storybook/addon-links: ^7.3.2 => 7.3.2
    @storybook/addon-svelte-csf: 4.0.0--canary.128.b77ea51.0 => 4.0.0--canary.128.b77ea51.0
    @storybook/blocks: ^7.3.2 => 7.3.2
    @storybook/svelte: ^7.3.2 => 7.3.2
    @storybook/sveltekit: ^7.3.2 => 7.3.2
    @storybook/testing-library: ^0.2.0 => 0.2.0

Here's the output with these changes (diffs mine):

-Environment Info:
+Storybook Environment Info:

  System:
    OS: macOS 13.1
    CPU: (10) arm64 Apple M1 Pro
+    Shell: 5.8.1 - /bin/zsh
  Binaries:
    Node: 16.19.1 - ~/.nvm/versions/node/v16.19.1/bin/node
    Yarn: 1.22.19 - ~/.nvm/versions/node/v16.19.1/bin/yarn
    npm: 8.19.3 - ~/.nvm/versions/node/v16.19.1/bin/npm
+    pnpm: 8.6.7 - ~/.nvm/versions/node/v16.19.1/bin/pnpm <----- active
  Browsers:
    Chrome: 116.0.5845.110
    Safari: 16.2
  npmPackages:
    @storybook/addon-essentials: ^7.3.2 => 7.3.2
    @storybook/addon-interactions: ^7.3.2 => 7.3.2
    @storybook/addon-links: ^7.3.2 => 7.3.2
    @storybook/addon-svelte-csf: 4.0.0--canary.128.b77ea51.0 => 4.0.0--canary.128.b77ea51.0
    @storybook/blocks: ^7.3.2 => 7.3.2
    @storybook/svelte: ^7.3.2 => 7.3.2
    @storybook/sveltekit: ^7.3.2 => 7.3.2
    @storybook/testing-library: ^0.2.0 => 0.2.0
+    chromatic: ^6.24.1 => 6.24.1
+    eslint-plugin-storybook: ^0.6.13 => 0.6.13
+    msw-storybook-addon: ^1.8.0 => 1.8.0
+    storybook: ^7.3.2 => 7.3.2
+    storybook-addon-pseudo-states: ^2.1.1 => 2.1.1
+  npmGlobalPackages:
+    storybook: 7.4.0

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

  1. Checkout this PR
  2. Build the CLI with yarn build cli from within the code directory
  3. cd to a separate project of yours
  4. Run <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

  • 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/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>

@JReinhold JReinhold self-assigned this Aug 30, 2023
@JReinhold JReinhold added maintenance User-facing maintenance tasks cli ci:normal labels Aug 30, 2023
@JReinhold JReinhold marked this pull request as ready for review August 30, 2023 06:46
Copy link
Member

@yannbf yannbf left a 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.

@JReinhold
Copy link
Contributor Author

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.

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.

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 using is actually using yarn/npm/pnpm.

great idea, I implemented that and updated the example output in the description.

Copy link
Member

@yannbf yannbf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome!!

@JReinhold JReinhold merged commit 7b268e1 into next Aug 30, 2023
16 of 17 checks passed
@JReinhold JReinhold deleted the better-storybook-info branch August 30, 2023 08:51
@yannbf yannbf mentioned this pull request Oct 17, 2023
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:normal cli maintenance User-facing maintenance tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants