Merge pull request #20 from kadirahq/use-yarn

Use yarn!
storybook-eol · Oct 12, 2016 · 8716c37 · 8716c37
2 parents ff0f2ce + af3ed49
commit 8716c37
Show file tree

Hide file tree

Showing 3 changed files with 56 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -20,4 +20,25 @@ That's all you've to do.
 
 ---
 
+## Yarn support
+
+getstorybook also supports yarn. If you are using yarn, this is how to use it:
+
+```
+yarn global add getstorybook
+getstorybook --use-yarn
+```
+
+`getstorybook` will identify it's installed with yarn and it'll use yarn to install deps.
+
+> This is the way, if you wanna use yarn for all of your storybook projects.
+
+If that's not the case, you can do this:
+
+```
+npm i -g getstorybook
+getstorybook --use-yarn
+
+```
+
 For more information, refer [React Storybook](https://github.com/kadirahq/react-storybook) documentation.
diff --git a/bin/generate.js b/bin/generate.js
@@ -9,7 +9,7 @@ var types = require('../lib/project_types');
 var commandLog = require('../lib/helpers').commandLog;
 var codeLog = require('../lib/helpers').codeLog;
 var paddedLog = require('../lib/helpers').paddedLog;
-var installNpmDeps = require('../lib/helpers').installNpmDeps;
+var installDeps = require('../lib/helpers').installDeps;
 var chalk = require('chalk');
 var logger = console;
 
@@ -18,12 +18,21 @@ var pkg = require('../package.json');
 program
   .version(pkg.version)
   .option('-f --force', 'Forcely add storybook')
+  .option('-Y --use-yarn', 'Use yarn to install deps')
   .parse(process.argv);
 
 var welcomeMessage =
   'getstorybook - the simplest way to add a storybook to your project.';
 logger.log(chalk.inverse('\n ' + welcomeMessage + ' \n'));
 
+var useYarn = Boolean(program.useYarn) || /\.yarn-cache/.test(__dirname);
+
+var npmOptions = {
+  useYarn: useYarn
+};
+
+var runStorybookCommand = useYarn? 'yarn run storybook' : 'npm run storybook';
+
 // Update notify code.
 updateNotifier({
   pkg: pkg,
@@ -55,11 +64,11 @@ switch (projectType) {
     require('../generators/REACT_SCRIPTS');
     done();
 
-    installNpmDeps();
+    installDeps(npmOptions);
 
     logger.log('\nTo run your storybook, type:\n');
     codeLog([
-      'npm run storybook'
+      runStorybookCommand
     ]);
     logger.log('\nFor more information visit:', chalk.cyan('http://getstorybook.io'));
     break;
@@ -69,11 +78,11 @@ switch (projectType) {
     require('../generators/REACT');
     done();
 
-    installNpmDeps();
+    installDeps(npmOptions);
 
     logger.log('\nTo run your storybook, type:\n');
     codeLog([
-      'npm run storybook'
+      runStorybookCommand
     ]);
     logger.log('\nFor more information visit:', chalk.cyan('http://getstorybook.io'));
     break;
@@ -83,11 +92,11 @@ switch (projectType) {
     require('../generators/REACT_NATIVE');
     done();
 
-    installNpmDeps();
+    installDeps(npmOptions);
 
     logger.log('\nTo run your storybook, type:\n');
     codeLog([
-      'npm run storybook'
+      runStorybookCommand
     ]);
     logger.log('\nFor more information visit:', chalk.cyan('http://getstorybook.io'));
     break;
@@ -97,11 +106,11 @@ switch (projectType) {
     require('../generators/METEOR');
     done();
 
-    installNpmDeps();
+    installDeps(npmOptions);
 
     logger.log('\nTo run your storybook, type:\n');
     codeLog([
-      'npm run storybook'
+      runStorybookCommand
     ]);
     logger.log('\nFor more information visit:', chalk.cyan('http://getstorybook.io'));
     break;
@@ -111,11 +120,11 @@ switch (projectType) {
     require('../generators/WEBPACK_REACT');
     done();
 
-    installNpmDeps();
+    installDeps(npmOptions);
 
     logger.log('\nTo run your storybook, type:\n');
     codeLog([
-      'npm run storybook'
+      runStorybookCommand
     ]);
     logger.log('\nFor more information visit:', chalk.cyan('http://getstorybook.io'));
     break;
@@ -125,11 +134,11 @@ switch (projectType) {
     require('../generators/REACT');
     done();
 
-    installNpmDeps();
+    installDeps(npmOptions);
 
     logger.log('\nTo run your storybook, type:\n');
     codeLog([
-      'npm run storybook'
+      runStorybookCommand
     ]);
     logger.log('\nFor more information visit:', chalk.cyan('http://getstorybook.io'));
     break;

diff --git a/lib/helpers.js b/lib/helpers.js
@@ -86,14 +86,22 @@ exports.codeLog = function codeLog(codeLines, leftPadAmount) {
   logger.log(finalResult);
 };
 
-exports.installNpmDeps = function () {
-  var done = exports.commandLog('Preparing to install NPM dependencies');
+exports.installDeps = function (options) {
+  var done = exports.commandLog('Preparing to install dependencies');
   done();
+  console.log();
 
-  var result = spawnSync('npm', ['install'], { stdio: 'inherit' });
-  done = exports.commandLog('Installing NPM dependencies');
+  var result;
+  if (options.useYarn) {
+    result = spawnSync('yarn', { stdio: 'inherit' });
+  } else {
+    result = spawnSync('npm', ['install'], { stdio: 'inherit' });
+  }
+
+  console.log();
+  done = exports.commandLog('Installing dependencies');
   if (result.status !== 0) {
-    done('An error occured while running `npm install`.');
+    done('An error occured while installing dependencies`.');
     process.exit(1);
   }
   done();