CLI: Provide guidance for users who try to initialize Storybook on an empty dir#23874
Merged
CLI: Provide guidance for users who try to initialize Storybook on an empty dir#23874
Conversation
9a4bf38 to
5b54e7c
Compare
Member
|
I'm not sure how I feel about this approach, but if we go this direction I'd propose the following changes:
|
Member
|
You know what. We’ve already spent way too much time on it. If you want, you can link off to the docs and not include the commands inline. But shorten the text per my suggestion. Let’s just get it shipped! 🚀 |
Additionally, improve the base generator when it comes to detecting builders
5b54e7c to
d2db9f2
Compare
ndelangen
reviewed
Aug 21, 2023
shilman
approved these changes
Aug 23, 2023
e34e1ea to
bdf3573
Compare
bdf3573 to
937473b
Compare
15 tasks
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
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.
Closes #
What I did
This PR provides a helpful message to users who try to initialize Storybook in an empty directory:

Additionally it fixes some bugs in the builder detection logic, so that if users run
npx storybook init --force, it will not ask for the builder multiple times, neither will it ask for the builder if the selected project does not support multiple builders.It also fixes an issue with CRA detection, and some type and linting errors, and excludes NX projects from the installable project types.
How to test
path/to/cli/bin/index.js initChecklist
MIGRATION.MD
Maintainers
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/src/sandbox-templates.ts["cleanup", "BREAKING CHANGE", "feature request", "bug", "build", "documentation", "maintenance", "dependencies", "other"]🦋 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/coreteam 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>