CLI: Exit when user does not select a storybook project type#23201
Merged
Conversation
yannbf
added
bug
cli
patch:yes
yannbf
force-pushed
the
fix/exit-on-init-unknown-project
branch
from
01fb91b to
c85081b
Compare
yannbf
commented
Jun 23, 2023
|
|
||
| logger.log(); | ||
| logger.log('For more information about installing Storybook: https://storybook.js.org/docs'); | ||
| process.exit(0); |
Member
Author
There was a problem hiding this comment.
@shilman reminder to check this later, thanks!
Member
There was a problem hiding this comment.
I'm ok with this. I think it's not great for our telemetry, but hopefully it's a small corner case.
valentinpalkovic
approved these changes
Jul 6, 2023
shilman
approved these changes
Jul 11, 2023
|
|
||
| logger.log(); | ||
| logger.log('For more information about installing Storybook: https://storybook.js.org/docs'); | ||
| process.exit(0); |
Member
There was a problem hiding this comment.
I'm ok with this. I think it's not great for our telemetry, but hopefully it's a small corner case.
| UNSUPPORTED = 'UNSUPPORTED', | ||
| REACT_SCRIPTS = 'REACT_SCRIPTS', | ||
| REACT = 'REACT', | ||
| REACT_SCRIPTS = 'REACT_SCRIPTS', |
Member
Author
There was a problem hiding this comment.
We have a big error count regarding "Storybook does not support react-scripts < 5.0.0" and this error can also be thrown when you choose react-scripts from the list of projects to install, but you don't have react-scripts installed.
I suspect what is influencing this count so much is that people just press enter when they get a list of options, and react-scripts is the first in the list. By changing the order, people will get react instead, free of the possibility of crashing with the react-scripts issue.
storybook-bot
pushed a commit
that referenced
this pull request
Jul 11, 2023
…roject CLI: Exit when user does not want to select a storybook project type (cherry picked from commit dcb93a7)
This was referenced Jul 11, 2023
Merged
storybook-bot
pushed a commit
that referenced
this pull request
Jul 11, 2023
…roject CLI: Exit when user does not want to select a storybook project type (cherry picked from commit dcb93a7)
15 tasks
storybook-bot
pushed a commit
that referenced
this pull request
Jul 11, 2023
…roject CLI: Exit when user does not want to select a storybook project type (cherry picked from commit dcb93a7)
storybook-bot
pushed a commit
that referenced
this pull request
Jul 12, 2023
…roject CLI: Exit when user does not want to select a storybook project type (cherry picked from commit dcb93a7)
storybook-bot
pushed a commit
that referenced
this pull request
Jul 12, 2023
…roject CLI: Exit when user does not want to select a storybook project type (cherry picked from commit dcb93a7)
valentinpalkovic
changed the title
storybook-bot
pushed a commit
that referenced
this pull request
Jul 12, 2023
…roject CLI: Exit when user does not want to select a storybook project type (cherry picked from commit dcb93a7)
github-actions
Bot
added
the
patch:done
8 tasks
ndelangen
removed
the
patch:yes
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
4 participants
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
Currently, when users try to install Storybook in a directory where no project type is detected, we prompt if they would like to select from a list. However, if the user selects "no", the process will continue and will get into a failure:
This PR fixes it by exiting the process successfully and providing link to the docs:
How to test
Checklist
MIGRATION.MD
Maintainers
make sure to add the
ci:mergedorci:dailyGH label to it.["cleanup", "BREAKING CHANGE", "feature request", "bug", "documentation", "maintenance", "dependencies", "other"]