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: Update copy for "features" question and options #30569

Merged
merged 1 commit into from
Feb 18, 2025

Conversation

ghengeveld
Copy link
Member

@ghengeveld ghengeveld commented Feb 18, 2025

What I did

Updated the "features" question to the following:

What do you want to use Storybook for?
o Documentation: MDX, auto-generated component docs
o Testing: Fast browser-based component tests, watch mode

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

name before after diff z %
createSize 0 B 0 B 0 B - -
generateSize 80.6 MB 80.6 MB 0 B 0.5 0%
initSize 80.6 MB 80.6 MB 0 B 0.5 0%
diffSize 97 B 97 B 0 B - 0%
buildSize 7.31 MB 7.31 MB 0 B 0.49 0%
buildSbAddonsSize 1.9 MB 1.9 MB 0 B - 0%
buildSbCommonSize 195 kB 195 kB 0 B - 0%
buildSbManagerSize 1.88 MB 1.88 MB 0 B 0.58 0%
buildSbPreviewSize 0 B 0 B 0 B - -
buildStaticSize 0 B 0 B 0 B - -
buildPrebuildSize 3.97 MB 3.97 MB 0 B 0.58 0%
buildPreviewSize 3.34 MB 3.34 MB 0 B 0.48 0%
testBuildSize 0 B 0 B 0 B - -
testBuildSbAddonsSize 0 B 0 B 0 B - -
testBuildSbCommonSize 0 B 0 B 0 B - -
testBuildSbManagerSize 0 B 0 B 0 B - -
testBuildSbPreviewSize 0 B 0 B 0 B - -
testBuildStaticSize 0 B 0 B 0 B - -
testBuildPrebuildSize 0 B 0 B 0 B - -
testBuildPreviewSize 0 B 0 B 0 B - -
name before after diff z %
createTime 6.6s 9.3s 2.6s -0.79 28.8%
generateTime 17.6s 30.6s 13s 6.16 🔺42.6%
initTime 4.3s 6.4s 2.1s 4.33 🔺33%
buildTime 8.3s 10.2s 1.9s 1.04 19%
testBuildTime 0ms 0ms 0ms - -
devPreviewResponsive 6.3s 4.8s -1s -438ms -1 -29.4%
devManagerResponsive 4.8s 3.7s -1s -170ms -1.06 -31.6%
devManagerHeaderVisible 854ms 662ms -192ms -1.16 -29%
devManagerIndexVisible 871ms 669ms -202ms -1.31 🔰-30.2%
devStoryVisibleUncached 4.2s 4s -123ms 0.37 -3%
devStoryVisible 946ms 694ms -252ms -1.24 🔰-36.3%
devAutodocsVisible 923ms 659ms -264ms -1.25 🔰-40.1%
devMDXVisible 837ms 607ms -230ms -1.69 🔰-37.9%
buildManagerHeaderVisible 880ms 625ms -255ms -1.41 🔰-40.8%
buildManagerIndexVisible 947ms 705ms -242ms -1.08 -34.3%
buildStoryVisible 856ms 611ms -245ms -1.37 🔰-40.1%
buildAutodocsVisible 845ms 462ms -383ms -1.46 🔰-82.9%
buildMDXVisible 662ms 496ms -166ms -1.72 🔰-33.5%

Greptile Summary

Improved the features selection prompt in Storybook's CLI initialization process to provide clearer descriptions of available features.

  • Updated prompt text to "What do you want to use Storybook for?" in code/lib/create-storybook/src/initiate.ts
  • Added descriptive labels for Documentation feature ("MDX, auto-generated component docs")
  • Added descriptive labels for Testing feature ("Fast browser-based component tests, watch mode")
  • Restructured selectableFeatures object to include both name and description properties

@ghengeveld ghengeveld added cli cleanup Minor cleanup style change that won't show up in release changelog ci:normal labels Feb 18, 2025
@ghengeveld ghengeveld requested a review from shilman February 18, 2025 13:54
@ghengeveld ghengeveld changed the title CLI: Rewording of features question and answers CLI: Update cope for "features" question and answers Feb 18, 2025
@ghengeveld ghengeveld changed the title CLI: Update cope for "features" question and answers CLI: Update cope for "features" question and options Feb 18, 2025
@ghengeveld ghengeveld changed the title CLI: Update cope for "features" question and options CLI: Update copy for "features" question and options Feb 18, 2025
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

LGTM

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

Copy link

nx-cloud bot commented Feb 18, 2025

View your CI Pipeline Execution ↗ for commit 92c02c5.

Command Status Duration Result
nx affected -t check -c production --parallel=7 ✅ Succeeded <1s View ↗
nx run-many -t build -c production --parallel=3 ✅ Succeeded 3s View ↗

☁️ Nx Cloud last updated this comment at 2025-02-18 14:06:33 UTC

@shilman shilman merged commit 89cc1c9 into next Feb 18, 2025
61 of 70 checks passed
@shilman shilman deleted the reword-features-question branch February 18, 2025 14:36
@github-actions github-actions bot mentioned this pull request Feb 18, 2025
7 tasks
Copy link
Contributor

Fails
🚫

Please choose only one of these labels: ["cleanup","documentation"]

Generated by 🚫 dangerJS against 92c02c5

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:normal cleanup Minor cleanup style change that won't show up in release changelog cli documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants