Refactor CLI to include commands that perform Storybook related actions

[ndelangen]

I have big plans for the cli:
I actually want to build something like this (eventually):

sb start   # starts and opens storybook 

sb start --public  # starts and create a temp public url to share

sb build  # builds to static site

sb deploy  # builds to static site & deploy to heroku

sb help <searchterm>  # search our documentation 

sb migrate  # run codemods to latest version

sb init  # adds storybook to project (auto-detect or asks)

sb init --react  # adds storybook for react to project

sb info  # show version, addons, system, config status 

---

Initialising could be done without a global install using npx:

npx sb -- init

Choose which template:

npx sb -- init --type=vue

system info:
https://github.com/tabrindle/envinfo

[usulpro]

In continuation of #764.
It would be nice to extend getstorybook with API which allow specifying custom templates in addition to those from @storybook/cli package.
I guess getstorybook was created to solve the issue of quick adding Storybook to the existing project. And it solved it at that stage, but the more new addons appear, the more time we need to spend to install them manually and harder to start using the project for beginners.

So providing additional customization could help with:

• including addons

• organizing files/folders structure

• adding custom decorators or anything else to stories

• adding specific boilerplates

Such templates could handle some specific use cases of Storybook

I think this API could look like this, for example:

getstorybook --with package

where package is everything that can be installed by npm i

Then we can provide some own extensions e.g.:

getstorybook --with @storybook/template-kitchen-sink

-- to get storybook with the maximum configuration

And other developers could create their own, like:

getstorybook --with https://github.com/react-theming/material-ui.git

what do you think?

[ndelangen]

I like the idea of adding addons via our cli.

I'm thinking we could add a add command to the future CLI:

sb add knobs

And in fact what would be really cool is if we could offer a autocomple feature here...

sb add

Would then use enquirer and a json-fetch to grab the list of recommended addons from https://storybook.js.org/addons.json

I really want to do away with the getstorybook uni-command that does absolutely everything using dark magic.

[ersel]

Just a quick update. I was busy for the last 2 weekends. Will pick this up following weekend.

[ersel]

I was bedridden with flu this weekend :( I have a 2 week holiday coming up, will make some time to pick it up before Xmas.

[ndelangen]

🎄 🎁

[gersongoulart]

@ndelangen are there any plans to allow programmatic usage of storybook's build system? I'm needing to do something like:

const storybook = require('build-storybook');
const buildConfig = {/* ... */};
//...
storybook(buildConfig);

I'd be more than happy to contribute with a PR, just need some direction on how to get started...

[ndelangen]

@gersongoulart I'd be happy to add this functionality to storybook.

How to exactly achieve this, I'd have to really dive into too. Right now, I just don't know either.

Let's have a look together, maybe you, me and @ersel can go on a skype-call together and figure this out?

[ersel]

I would be happy to have a call any time this week.

[ndelangen]

@gersongoulart when would you be available? Would you mind joining our slack so we can communicate easier?

self invite link

[gersongoulart]

@ndelangen, @ersel sorry for the delay, much going on lately. The "self invite link" above is no longer working (probably expired). I'm in Vancouver (UTC-08:00) but would be more than happy to join in a Skype call whenever works best for you.

[ndelangen]

UPDATED the link above

[danielduan]

@ndelangen can we close this one?

I'd like to make these tickets more scoped in the future so they aren't open forever. If we are planning to add addons via the CLI, can we create a new ticket specifically for that?

[ersel]

Sorry for the radio silence, my circumstances have changed since we last spoke. I have recently started a new job and don't have time to pick this up anymore. Hope someone else can pick it up.

[wuweiweiwu]

@ndelangen @danielduan I'd like to take this up!

Seems like a large todo list..

perhaps starting with adding packages via the getstorybook cli?

• add packages via getstorybook
• search documentation via cli
• create storybook cli
• everything here Refactor CLI to include commands that perform Storybook related actions #1108 (comment)
• add addons via storybook cli

[ndelangen]

@wuweiweiwu and me are going to discuss this epic tomorrow evening.

[Keraito]

I would definitely like to help out with this when we're actively working on it! 😍

[Keraito]

Really wanted to work on this, so reached out the @ndelangen on Slack and for now the short term goals are to:

• Change the current CLI to be able to handle more than just one thing.
• Implement the trivial commands like start and build.
• Probably also some migrations of tests.

After that, it can be expanded with all the ideas in this issue.
@wuweiweiwu, are you still down to work on this?

[libetl]

storybook snippets [framework] : add some sample snippets from the chosen framework (detected one or in param) as stories
We could also inject them from the kitchen sinks

[libetl]

storybook upgrade : upgrade to latest version of the cli

[libetl]

mmmh... storybook deploy is it worth trying surge instead ? surge would be free.

[libetl]

storybook test : run the storyshots ?

[kohakukun]

Is there work left to do for this feature? I would like to work on this

[shilman]

Hurrah!! I just released https://github.com/storybookjs/storybook/releases/tag/v5.2.0-alpha.44 containing PR #7414 that references this issue. Upgrade today to try it out!

You can find this prerelease on the @next NPM tag.

Closing this issue. Please re-open if you think there's still more to do.