GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-04 15:11:10 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4168 from Keraito/cli-refactor

Browse Source 
CLI refactor
This commit is contained in:
Igor 2018-09-16 09:32:36 +03:00 committed by GitHub
commit 4ee8dc4299
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
22 changed files with 257 additions and 208 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
MIGRATION.md
View File

@ -207,7 +207,7 @@ To update your app to use the new package names, you can use the cli:
npm install --global @storybook/cli
# if you run this inside a v2 app, it should perform the necessary codemods.
getstorybook
storybook init
```
#### Details

2
app/angular/README.md
View File

@ -13,7 +13,7 @@ So you can develop UI components in isolation without worrying about app specifi
```sh
npm i -g @storybook/cli
cd my-angular-app
getstorybook
storybook init
```
For more information visit: [storybook.js.org](https://storybook.js.org)

2
app/html/README.md
View File

@ -15,7 +15,7 @@ So you can develop UI components in isolation without worrying about app specifi
```sh
npm i -g @storybook/cli
cd my-app
getstorybook --html
storybook init --html
```
For more information visit: [storybook.js.org](https://storybook.js.org)

2
app/marko/README.md
View File

@ -13,7 +13,7 @@ So you can develop UI components in isolation without worrying about app specifi
```sh
npm i -g @storybook/cli
cd my-marko-app
getstorybook
storybook init
```
For more information visit: [storybook.js.org](https://storybook.js.org)

2
app/mithril/README.md
View File

@ -13,7 +13,7 @@ So you can develop UI components in isolation without worrying about app specifi
```sh
npm i -g @storybook/cli
cd my-mithril-app
getstorybook
storybook init
```
For more information visit: [storybook.js.org](https://storybook.js.org)

2
app/polymer/README.md
View File

@ -15,7 +15,7 @@ So you can develop UI components in isolation without worrying about app specifi
```sh
npm i -g @storybook/cli
cd my-polymer-app
getstorybook
storybook init
```
For more information visit: [storybook.js.org](https://storybook.js.org)

6
app/react-native/readme.md
View File

@ -8,11 +8,11 @@ For more information visit: [storybook.js.org](https://storybook.js.org)
## Getting Started
The `getstorybook` tool can be used to add Storybook to your React Native app. Install the `getstorybook` tool if necessary and run it from your project directory with these commands:
The `storybook` CLI tool can be used to add Storybook to your React Native app. Install the `storybook` tool if necessary and run it from your project directory with these commands:
```shell
npm -g i @storybook/cli
getstorybook
storybook init
```
After you have installed, there are additional steps for `create-react-native-app` apps. See the section for details, otherwise skip to [Start Storybook](#start-storybook)
@ -20,7 +20,7 @@ to see the next step.
## Create React Native App (CRNA)
If you run `getstorybook` inside a CRNA app, you'll be notified that there is an extra step required to use Storybook.
If you run `storybook init` inside a CRNA app, you'll be notified that there is an extra step required to use Storybook.
The easiest way to use Storybook inside CRNA is to simply replace your App with the Storybook UI, which is possible by replacing `App.js` with a single line of code:

2
app/react/README.md
View File

@ -13,7 +13,7 @@ So you can develop UI components in isolation without worrying about app specifi
```sh
npm i -g @storybook/cli
cd my-react-app
getstorybook
storybook init
```
For more information visit: [storybook.js.org](https://storybook.js.org)

2
app/riot/README.md
View File

@ -15,7 +15,7 @@ So you can develop UI components in isolation without worrying about app specifi
```sh
npm i -g @storybook/cli
cd my-app
getstorybook
storybook init
```
For more information visit: [storybook.js.org](https://storybook.js.org)

2
app/svelte/README.md
View File

@ -13,7 +13,7 @@ So you can develop UI components in isolation without worrying about app specifi
```sh
npm i -g @storybook/cli
cd my-svelte-app
getstorybook
storybook init
```
For more information visit: [storybook.js.org](https://storybook.js.org)

2
app/vue/README.md
View File

@ -13,7 +13,7 @@ So you can develop UI components in isolation without worrying about app specifi
```sh
npm i -g @storybook/cli
cd my-vue-app
getstorybook
storybook init
```
For more information visit: [storybook.js.org](https://storybook.js.org)

2
examples/crna-kitchen-sink/README.md
View File

@ -1,3 +1,3 @@
# CRNA Kitchen Sink
This project was bootstrapped with [Create React Native App](https://github.com/react-community/create-react-native-app) and storybook using [getstorybook](https://www.npmjs.com/package/@storybook/cli).
This project was bootstrapped with [Create React Native App](https://github.com/react-community/create-react-native-app) and storybook using [storybook CLI](https://www.npmjs.com/package/@storybook/cli).

2
examples/marko-cli/README.md
View File

@ -1,3 +1,3 @@
# Marko Kitchen Sink
This project was bootstrapped with [Marko cli (create command)](https://github.com/marko-js/marko-cli) and storybook using [getstorybook](https://www.npmjs.com/package/@storybook/cli).
This project was bootstrapped with [Marko cli (create command)](https://github.com/marko-js/marko-cli) and storybook using [storybook CLI](https://www.npmjs.com/package/@storybook/cli).

6
lib/cli/README.md
View File

@ -15,7 +15,7 @@ npm i -g @storybook/cli
Then go to your project run:
```sh
getstorybook
storybook init
```
That's all you've to do.
@ -30,7 +30,7 @@ If you have installed yarn in your system, it'll detect it and use `yarn` instea
If you don't want to use `yarn` always you can use the `--use-npm` option like this:
```sh
getstorybook --use-npm
storybook init --use-npm
```
* * *
@ -40,7 +40,7 @@ getstorybook --use-npm
It also supports flow files. By default, [jscodeshift](https://github.com/facebook/jscodeshift), the tool used to transform the source files, uses babel to read the files. To be able to transform any flow annotated file, you need to use the flow parser.
```sh
getstorybook --parser flow
storybook init --parser flow
```
For more information visit: [storybook.js.org](https://storybook.js.org)

217
lib/cli/bin/generate.js
View File

@ -1,201 +1,50 @@
import updateNotifier from 'update-notifier';
import program from 'commander';
import chalk from 'chalk';
import detect from '../lib/detect';
import hasYarn from '../lib/has_yarn';
import types from '../lib/project_types';
import { commandLog, codeLog, paddedLog, installDeps } from '../lib/helpers';
import pkg from '../package.json';
import angularGenerator from '../generators/ANGULAR';
import meteorGenerator from '../generators/METEOR';
import reactGenerator from '../generators/REACT';
import reactNativeGenerator from '../generators/REACT_NATIVE';
import reactNativeScriptsGenerator from '../generators/REACT_NATIVE_SCRIPTS';
import reactScriptsGenerator from '../generators/REACT_SCRIPTS';
import sfcVueGenerator from '../generators/SFC_VUE';
import updateOrganisationsGenerator from '../generators/UPDATE_PACKAGE_ORGANIZATIONS';
import vueGenerator from '../generators/VUE';
import polymerGenerator from '../generators/POLYMER';
import webpackReactGenerator from '../generators/WEBPACK_REACT';
import mithrilGenerator from '../generators/MITHRIL';
import markoGenerator from '../generators/MARKO';
import htmlGenerator from '../generators/HTML';
import riotGenerator from '../generators/RIOT';
import initiate from '../lib/initiate';
import yarnSpawnSync from '../lib/yarn_spawn_sync';
import { codeLog } from '../lib/helpers';
const logger = console;
if (process.argv[1].includes('getstorybook')) {
logger.log(chalk.yellow('WARNING: getstorybook is deprecated.'));
logger.log(chalk.yellow('The official command to install Storybook from now on is:\n'));
codeLog(['storybook init']);
logger.log();
initiate({}, pkg);
process.exit(0);
}
program
.version(pkg.version)
.command('init')
.description('Initialize Storybook into your project.')
.option('-f --force', 'Forcely add storybook')
.option('-s --skip-install', 'Skip installing deps')
.option('-N --use-npm', 'Use npm to install deps')
.option('-p --parser <babel | babylon | flow>', 'jscodeshift parser')
.option('-h --html', 'Add storybook for HTML')
.parse(process.argv);
.action(options => initiate(options, pkg));
const welcomeMessage = 'getstorybook - the simplest way to add a storybook to your project.';
logger.log(chalk.inverse(`\n ${welcomeMessage} \n`));
program
.command('start')
.description('Start the local Storybook server')
.option('-N --use-npm', 'Use NPM to start the Storybook server')
.action(options => yarnSpawnSync(options, ['run', 'storybook']));
const useYarn = Boolean(program.useNpm !== true) && hasYarn();
program
.command('build')
.description('Build the Storybook static application')
.option('-N --use-npm', 'Use NPM to build the Storybook server')
.action(options => yarnSpawnSync(options, ['build', 'storybook']));
const npmOptions = {
useYarn,
};
const runStorybookCommand = useYarn ? 'yarn run storybook' : 'npm run storybook';
// Update notify code.
updateNotifier({
pkg,
updateCheckInterval: 1000 * 60 * 60, // every hour (we could increase this later on.)
}).notify();
let projectType;
const done = commandLog('Detecting project type');
try {
projectType = detect(program);
} catch (ex) {
done(ex.message);
process.exit(1);
}
done();
const end = () => {
if (!program.skipInstall) {
installDeps(npmOptions);
}
logger.log('\nTo run your storybook, type:\n');
codeLog([runStorybookCommand]);
logger.log('\nFor more information visit:', chalk.cyan('https://storybook.js.org'));
// Add a new line for the clear visibility.
logger.log();
};
const CRNA_DISCUSSION =
'https://github.com/storybooks/storybook/blob/master/app/react-native/docs/manual-setup.md';
const runGenerator = () => {
switch (projectType) {
case types.ALREADY_HAS_STORYBOOK:
logger.log();
paddedLog('There seems to be a storybook already available in this project.');
paddedLog('Apply following command to force:\n');
codeLog(['getstorybook -f']);
// Add a new line for the clear visibility.
logger.log();
return Promise.resolve();
case types.UPDATE_PACKAGE_ORGANIZATIONS:
return updateOrganisationsGenerator(program.parser, npmOptions)
.then(() => null) // commmandLog doesn't like to see output
.then(commandLog('Upgrading your project to the new storybook packages.'))
.then(end);
case types.REACT_SCRIPTS:
return reactScriptsGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "Create React App" based project'))
.then(end);
case types.REACT:
return reactGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "React" app'))
.then(end);
case types.REACT_NATIVE_SCRIPTS: {
const app = chalk.bold('"./App.js"');
return reactNativeScriptsGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "Create React Native App" app'))
.then(end)
.then(() => {
logger.log(chalk.red('NOTE: CRNA app installation is not 100% automated.'));
logger.log(`To quickly run storybook, replace contents of ${app} with:\n`);
codeLog(["export default from './storybook';"]);
logger.log('\nFor a more complete discussion of options, see:\n');
logger.log(chalk.cyan(CRNA_DISCUSSION));
logger.log();
});
}
case types.REACT_NATIVE:
return reactNativeGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "React Native" app'))
.then(end);
case types.METEOR:
return meteorGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "Meteor" app'))
.then(end);
case types.WEBPACK_REACT:
return webpackReactGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "Webpack React" app'))
.then(end);
case types.REACT_PROJECT:
return reactGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "React" library'))
.then(end);
case types.SFC_VUE:
return sfcVueGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "Single File Components Vue" app'))
.then(end);
case types.VUE:
return vueGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "Vue" app'))
.then(end);
case types.ANGULAR:
return angularGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "Angular" app'))
.then(end);
case types.POLYMER:
return polymerGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "Polymer" app'))
.then(end);
case types.MITHRIL:
return mithrilGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "Mithril" app'))
.then(end);
case types.MARKO:
return markoGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "Marko" app'))
.then(end);
case types.HTML:
return htmlGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "HTML" app'))
.then(end);
case types.RIOT:
return riotGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "riot.js" app'))
.then(end);
default:
paddedLog(`We couldn't detect your project type. (code: ${projectType})`);
paddedLog(
"Please make sure you are running the `getstorybook` command in your project's root directory."
);
paddedLog(
'You can also install storybook for plain HTML snippets with `getstorybook --html` or follow some of the slow start guides: https://storybook.js.org/basics/slow-start-guide/'
);
// Add a new line for the clear visibility.
logger.log();
return Promise.resolve();
}
};
runGenerator().catch(ex => {
logger.error(`\n ${chalk.red(ex.stack)}`);
program.command('*', { noHelp: true }).action(cmd => {
logger.error('Invalid command: %s.\nSee --help for a list of available commands.', cmd);
process.exit(1);
});
program.version(pkg.version).parse(process.argv);
if (!program.args.length) {
program.help();
}

192
lib/cli/lib/initiate.js Normal file
View File

@ -0,0 +1,192 @@
import updateNotifier from 'update-notifier';
import chalk from 'chalk';
import detect from './detect';
import hasYarn from './has_yarn';
import types from './project_types';
import { commandLog, codeLog, paddedLog, installDeps } from './helpers';
import angularGenerator from '../generators/ANGULAR';
import meteorGenerator from '../generators/METEOR';
import reactGenerator from '../generators/REACT';
import reactNativeGenerator from '../generators/REACT_NATIVE';
import reactNativeScriptsGenerator from '../generators/REACT_NATIVE_SCRIPTS';
import reactScriptsGenerator from '../generators/REACT_SCRIPTS';
import sfcVueGenerator from '../generators/SFC_VUE';
import updateOrganisationsGenerator from '../generators/UPDATE_PACKAGE_ORGANIZATIONS';
import vueGenerator from '../generators/VUE';
import polymerGenerator from '../generators/POLYMER';
import webpackReactGenerator from '../generators/WEBPACK_REACT';
import mithrilGenerator from '../generators/MITHRIL';
import markoGenerator from '../generators/MARKO';
import htmlGenerator from '../generators/HTML';
import riotGenerator from '../generators/RIOT';
const logger = console;
export default function(options, pkg) {
const welcomeMessage = 'storybook init - the simplest way to add a storybook to your project.';
logger.log(chalk.inverse(`\n ${welcomeMessage} \n`));
const useYarn = Boolean(options.useNpm !== true) && hasYarn();
const npmOptions = {
useYarn,
};
const runStorybookCommand = 'storybook start';
// Update notify code.
updateNotifier({
pkg,
updateCheckInterval: 1000 * 60 * 60, // every hour (we could increase this later on.)
}).notify();
let projectType;
const done = commandLog('Detecting project type');
try {
projectType = detect(options);
} catch (ex) {
done(ex.message);
process.exit(1);
}
done();
const end = () => {
if (!options.skipInstall) {
installDeps(npmOptions);
}
logger.log('\nTo run your storybook, type:\n');
codeLog([runStorybookCommand]);
logger.log('\nFor more information visit:', chalk.cyan('https://storybook.js.org'));
// Add a new line for the clear visibility.
logger.log();
};
const CRNA_DISCUSSION =
'https://github.com/storybooks/storybook/blob/master/app/react-native/docs/manual-setup.md';
const runGenerator = () => {
switch (projectType) {
case types.ALREADY_HAS_STORYBOOK:
logger.log();
paddedLog('There seems to be a storybook already available in this project.');
paddedLog('Apply following command to force:\n');
codeLog(['storybook init -f']);
// Add a new line for the clear visibility.
logger.log();
return Promise.resolve();
case types.UPDATE_PACKAGE_ORGANIZATIONS:
return updateOrganisationsGenerator(options.parser, npmOptions)
.then(() => null) // commmandLog doesn't like to see output
.then(commandLog('Upgrading your project to the new storybook packages.'))
.then(end);
case types.REACT_SCRIPTS:
return reactScriptsGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "Create React App" based project'))
.then(end);
case types.REACT:
return reactGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "React" app'))
.then(end);
case types.REACT_NATIVE_SCRIPTS: {
const app = chalk.bold('"./App.js"');
return reactNativeScriptsGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "Create React Native App" app'))
.then(end)
.then(() => {
logger.log(chalk.red('NOTE: CRNA app installation is not 100% automated.'));
logger.log(`To quickly run storybook, replace contents of ${app} with:\n`);
codeLog(["export default from './storybook';"]);
logger.log('\nFor a more complete discussion of options, see:\n');
logger.log(chalk.cyan(CRNA_DISCUSSION));
logger.log();
});
}
case types.REACT_NATIVE:
return reactNativeGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "React Native" app'))
.then(end);
case types.METEOR:
return meteorGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "Meteor" app'))
.then(end);
case types.WEBPACK_REACT:
return webpackReactGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "Webpack React" app'))
.then(end);
case types.REACT_PROJECT:
return reactGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "React" library'))
.then(end);
case types.SFC_VUE:
return sfcVueGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "Single File Components Vue" app'))
.then(end);
case types.VUE:
return vueGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "Vue" app'))
.then(end);
case types.ANGULAR:
return angularGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "Angular" app'))
.then(end);
case types.POLYMER:
return polymerGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "Polymer" app'))
.then(end);
case types.MITHRIL:
return mithrilGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "Mithril" app'))
.then(end);
case types.MARKO:
return markoGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "Marko" app'))
.then(end);
case types.HTML:
return htmlGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "HTML" app'))
.then(end);
case types.RIOT:
return riotGenerator(npmOptions)
.then(commandLog('Adding storybook support to your "riot.js" app'))
.then(end);
default:
paddedLog(`We couldn't detect your project type. (code: ${projectType})`);
paddedLog(
"Please make sure you are running the `storybook init` command in your project's root directory."
);
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/'
);
// Add a new line for the clear visibility.
logger.log();
return Promise.resolve();
}
};
runGenerator().catch(ex => {
logger.error(`\n ${chalk.red(ex.stack)}`);
process.exit(1);
});
}

7
lib/cli/lib/yarn_spawn_sync.js Normal file
View File

@ -0,0 +1,7 @@
import { spawn as spawnSync } from 'cross-spawn';
import hasYarn from './has_yarn';
export default function yarnSpawnSync(options, args) {
const pkgmgr = Boolean(options.useNpm !== true) && hasYarn() ? 'yarn' : 'npm';
spawnSync(pkgmgr, args, { stdio: 'inherit' });
}

3
lib/cli/package.json
View File

@ -18,7 +18,8 @@
"license": "MIT",
"author": "Storybook Team",
"bin": {
"getstorybook": "./bin/index.js"
"getstorybook": "./bin/index.js",
"storybook": "./bin/index.js"
},
"scripts": {
"test": "cd test && ./run_tests.sh",

2
lib/cli/test/fixtures/already_has_storybook/README.md vendored
View File

@ -1514,7 +1514,7 @@ npm install -g @storybook/cli
Then, run the following command inside your app’s directory:
```sh
getstorybook
storybook init
```
After that, follow the instructions on the screen.

2
lib/cli/test/fixtures/react_scripts/README.md vendored
View File

@ -1514,7 +1514,7 @@ npm install -g @storybook/cli
Then, run the following command inside your app’s directory:
```sh
getstorybook
storybook init
```
After that, follow the instructions on the screen.

4
lib/cli/test/fixtures/update_package_organisations/README.md vendored
View File

@ -1178,13 +1178,13 @@ You can also deploy your Storybook as a static app. This way, everyone in your t
First, install the following npm package globally:
```sh
npm install -g getstorybook
npm install -g storybook
```
Then, run the following command inside your app’s directory:
```sh
getstorybook
storybook init
```
After that, follow the instructions on the screen.

2
lib/cli/test/run_tests.sh
View File

@ -48,7 +48,7 @@ do
cd $dir
# run @storybook/cli
../../../bin/index.js --skip-install
../../../bin/index.js init --skip-install
cd ..
done