Rename CLI to sb #4345
Merged
Rename CLI to sb #4345
Conversation
This file contains 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
We use "yarn storybook" everywhere and creating a CLI called "storybook" introduces a name conflict. Plus "sb" is shorter.
"sb start/build" should call start-storybook and build-storybook directly, rather than calling "yarn storybook". This way we can use "sb start/build" in the package.json NPM scripts and expose users to the CLI that way. For now let's remove it.
shilman
requested review from
Hypnosphi,
ndelangen and
stijnkoopal
as code owners
Merged
Codecov Report
@@ Coverage Diff @@
## master #4345 +/- ##
==========================================
+ Coverage 39.98% 40.04% +0.06%
==========================================
Files 504 503 -1
Lines 5912 5903 -9
Branches 795 795
==========================================
Hits 2364 2364
+ Misses 3165 3156 -9
Partials 383 383
Continue to review full report at Codecov.
|
Keraito
approved these changes
Oct 10, 2018
MIGRATION.md
Outdated
| @@ -134,6 +135,14 @@ Also make sure you have a `.babelrc` in your project directory. You probably alr | |||
|
|
|||
| If you're using `start-storybook` on CI, you may need to opt out of this using the new `--ci` flag. | |||
|
|
|||
| ### CLI Rename | |||
|
|
|||
| We've deprecated the `getstorybook` CLI in 4.0. The new way to install storybook is `sb init`. We recommend installing using `npx` for convenience and to make sure you're always using the latest version of the CLI: | |||
| ); | ||
| paddedLog( | ||
| 'You can also install storybook for plain HTML snippets with `storybook init --html` or follow some of the slow start guides: https://storybook.js.org/basics/slow-start-guide/' | ||
| 'You can also install storybook for plain HTML snippets with `sb init --html` or follow some of the slow start guides: https://storybook.js.org/basics/slow-start-guide/' |
There was a problem hiding this comment.
@Keraito Merging now --- sorry to create extra work on the resolve, but my change is a small one
There was a problem hiding this comment.
No problem, won't be too much
This was referenced Nov 1, 2018
This was referenced Dec 1, 2018
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.
Issue: #4168
What I did
Per discussion with @Keraito @tmeasday @ndelangen
sbto avoid conflicts with storybook NPM script. We useyarn storybookeverywhere and creating a CLI calledstorybookintroduces a name conflict. After the rename, users can add the CLI locally in the project and access it by runningyarn sb xxx. This isn't important now sinceinitis the only supported command, but it will be important later when we start adding more commands. Plussbis shorter.sb start/buildshould call start-storybook and build-storybook directly, rather than callingyarn storybook. This way we can usesb start/buildin thepackage.jsonNPM scripts and expose users to the CLI that way. For now let's remove it and keep things simple.Note
I tried to make
npx @storybook/cli initwork, but it currently usesgetstorybookas the associated binary. I reordered the binary declaration in this PR, but that didn't seem to change things. For now-pworks and is much better than a global install IMHO.How to test