feat(build): use options to control cli/shell run

Author: raymondfeng

packages/build/bin/compile-package.js

@@ -114,7 +114,7 @@ function run(argv, dryRun) {
 
   args.push(...compilerOpts);
 
-  return utils.runCLI('typescript/lib/tsc', args, dryRun);
+  return utils.runCLI('typescript/lib/tsc', args, {dryRun});
 }
 
 module.exports = run;

packages/build/bin/generate-apidocs.js

@@ -45,7 +45,7 @@ function run(argv, dryRun) {
     args.push('-o', 'api-docs');
   }
   args.push(...apidocsOpts);
-  return utils.runCLI('strong-docs/bin/cli', args, dryRun);
+  return utils.runCLI('strong-docs/bin/cli', args, {dryRun});
 }
 
 module.exports = run;

packages/build/bin/run-clean.js

@@ -35,7 +35,9 @@ function run(argv, dryRun) {
   files.forEach(f => {
     var file = path.relative(process.cwd(), f);
     if (file.indexOf('..') !== -1) {
-      console.error('Skipping ' + f + ' as it is not inside the project');
+      if (!dryRun) {
+        console.error('Skipping ' + f + ' as it is not inside the project');
+      }
     } else {
       if (!dryRun) fs.removeSync(f);
       removed.push(f);

packages/build/bin/run-mocha.js

@@ -52,7 +52,7 @@ function run(argv, dryRun) {
 
   const args = [...mochaOpts];
 
-  return utils.runCLI('mocha/bin/mocha', args, dryRun);
+  return utils.runCLI('mocha/bin/mocha', args, {dryRun});
 }
 
 module.exports = run;

packages/build/bin/run-nyc.js

@@ -22,7 +22,7 @@ function run(argv, dryRun) {
   const nycOpts = argv.slice(2);
   const args = [...nycOpts];
 
-  return utils.runCLI('nyc/bin/nyc', args, dryRun);
+  return utils.runCLI('nyc/bin/nyc', args, {dryRun});
 }
 
 module.exports = run;

packages/build/bin/run-prettier.js

@@ -34,7 +34,7 @@ function run(argv, dryRun) {
   }
   args.push(...prettierOpts);
 
-  return utils.runCLI('prettier/bin-prettier', args, dryRun);
+  return utils.runCLI('prettier/bin-prettier', args, {dryRun});
 }
 
 module.exports = run;

packages/build/bin/run-tslint.js

@@ -39,7 +39,7 @@ function run(argv, dryRun) {
   }
   args.push(...tslintOpts);
 
-  return utils.runCLI('tslint/bin/tslint', args, dryRun);
+  return utils.runCLI('tslint/bin/tslint', args, {dryRun});
 }
 
 module.exports = run;

packages/build/bin/select-dist.js

@@ -32,7 +32,7 @@ function run(argv, dryRun) {
   const args = argv.slice(2).map(a => a.replace(/\bDIST\b/g, dist));
   const command = args.shift();
 
-  return utils.runShell(command, args, dryRun);
+  return utils.runShell(command, args, {dryRun});
 }
 
 module.exports = run;

packages/build/bin/utils.js

@@ -104,23 +104,30 @@ function resolveCLI(cli) {
  * Run a command with the given arguments
  * @param {string} cli Path of the cli command
  * @param {string[]} args The arguments
- * @param {boolean} dryRun Controls if the cli will be executed or not. If set
+ * @param {object} options Options to control dryRun and spawn
+ * - dryRun Controls if the cli will be executed or not. If set
  * to true, the command itself will be returned without running it
  */
-function runCLI(cli, args, dryRun) {
+function runCLI(cli, args, options) {
   cli = resolveCLI(cli);
   args = [cli].concat(args);
   debug('%s', args.join(' '));
-  if (dryRun) {
+  // Keep it backward compatible as dryRun
+  if (typeof options === 'boolean') options = {dryRun: options};
+  options = options || {};
+  if (options.dryRun) {
     return util.format('%s %s', process.execPath, args.join(' '));
   }
   var child = spawn(
     process.execPath, // Typically '/usr/local/bin/node'
     args,
-    {
-      stdio: 'inherit',
-      env: Object.create(process.env),
-    }
+    Object.assign(
+      {
+        stdio: 'inherit',
+        env: Object.create(process.env),
+      },
+      options
+    )
   );
   child.on('close', (code, signal) => {
     debug('%s exits: %d', cli, code);
@@ -133,23 +140,34 @@ function runCLI(cli, args, dryRun) {
  * Run the command in a shell
  * @param {string} command The command
  * @param {string[]} args The arguments
- * @param {boolean} dryRun Controls if the cli will be executed or not. If set
+ * @param {object} options Options to control dryRun and spawn
+ * - dryRun Controls if the cli will be executed or not. If set
  * to true, the command itself will be returned without running it
  */
-function runShell(command, args, dryRun) {
+function runShell(command, args, options) {
   args = args.map(a => JSON.stringify(a));
   debug('%s %s', command, args.join(' '));
-  if (dryRun) {
+  // Keep it backward compatible as dryRun
+  if (typeof options === 'boolean') options = {dryRun: options};
+  options = options || {};
+  if (options.dryRun) {
     return util.format('%s %s', command, args.join(' '));
   }
-  var child = spawn(command, args, {
-    stdio: 'inherit',
-    env: Object.create(process.env),
-    // On Windows, npm creates `.cmd` files instead of symlinks in
-    // `node_modules/.bin` folder. These files cannot be executed directly,
-    // only via a shell.
-    shell: true,
-  });
+  var child = spawn(
+    command,
+    args,
+    Object.assign(
+      {
+        stdio: 'inherit',
+        env: Object.create(process.env),
+        // On Windows, npm creates `.cmd` files instead of symlinks in
+        // `node_modules/.bin` folder. These files cannot be executed directly,
+        // only via a shell.
+        shell: true,
+      },
+      options
+    )
+  );
   child.on('close', (code, signal) => {
     debug('%s exits: %d', command, code);
     process.exitCode = code;

packages/cli/test/app-run.test.js

@@ -43,10 +43,15 @@ describe('app-generator', function() {
   it('passes `npm test` for the generated project', () => {
     process.chdir(sandbox);
     return new Promise((resolve, reject) => {
-      build.runShell('npm', ['test']).on('close', code => {
-        assert.equal(code, 0);
-        resolve();
-      });
+      build
+        .runShell('npm', ['test'], {
+          // Disable stdout
+          stdio: [process.stdin, 'ignore', process.stderr],
+        })
+        .on('close', code => {
+          assert.equal(code, 0);
+          resolve();
+        });
     });
   });