Replace child_process.exec with child_process.spawn

Author: sun-zheng-an

README.md

@@ -91,9 +91,7 @@ type: `String`
 default: ``Command `<%= command %>` failed with exit code <%= error.code %>``
 
 You can add a custom error message for when the command fails.
-This can be a [template][] which can be interpolated with the current `command`, some [file][] info (e.g. `file.path`) and some [error][] info (e.g. `error.code`).
-
-[error]: http://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback
+This can be a [template][] which can be interpolated with the current `command`, some [file][] info (e.g. `file.path`) and some error info (e.g. `error.code`).
 
 #### options.ignoreErrors
 
@@ -111,14 +109,6 @@ default: `false`
 
 By default, it will print the command output.
 
-#### options.interactive
-
-type: `Boolean`
-
-default: `false`
-
-Turn it on only if you need to run some interactive commands.
-
 #### options.cwd
 
 type: `String`
@@ -135,24 +125,6 @@ type: `Object`
 
 The data that can be accessed in template.
 
-#### options.maxBuffer
-
-type: `Number`
-
-default: 16MB(16 * 1024 * 1024)
-
-You won't need to set this option unless you encounter a "stdout maxBuffer exceeded" error.
-
-For example, setting it to `16 * 1024 * 1024` will result in 16MB.
-
-#### options.timeout
-
-type: `Number`
-
-default: undefined (no timeout)
-
-The maximum amount of time in milliseconds the process is allowed to run.
-
 #### options.env
 
 type: `Object`

gulpfile.js

@@ -5,9 +5,9 @@ var paths = {
   js: ['*.js', 'test/*.js']
 }
 
-gulp.task('test', shell.task('mocha -c'))
+gulp.task('test', shell.task('mocha'))
 
-gulp.task('coverage', ['test'], shell.task('istanbul cover _mocha -- -c'))
+gulp.task('coverage', ['test'], shell.task('istanbul cover _mocha'))
 
 gulp.task('coveralls', ['coverage'], shell.task('cat coverage/lcov.info | coveralls'))
 

index.js

@@ -1,8 +1,8 @@
 var _ = require('lodash')
 var async = require('async')
-var exec = require('child_process').exec
 var gutil = require('gulp-util')
 var path = require('path')
+var spawn = require('child_process').spawn
 var through = require('through2')
 
 var PLUGIN_NAME = 'gulp-shell'
@@ -25,9 +25,7 @@ function normalizeOptions (options) {
     ignoreErrors: false,
     errorMessage: 'Command `<%= command %>` failed with exit code <%= error.code %>',
     quiet: false,
-    interactive: false,
-    cwd: process.cwd(),
-    maxBuffer: 16 * 1024 * 1024
+    cwd: process.cwd()
   }, options)
 
   var pathToBin = path.join(process.cwd(), 'node_modules', '.bin')
@@ -47,44 +45,28 @@ function runCommands (commands, options, file, done) {
       gutil.log(gutil.colors.cyan(command))
     }
 
-    var child = exec(command, {
+    var child = spawn(command, {
       env: options.env,
       cwd: gutil.template(options.cwd, context),
-      maxBuffer: options.maxBuffer,
-      timeout: options.timeout
-    }, function (error, stdout, stderr) {
-      if (options.interactive) {
-        process.stdin.unpipe(child.stdin)
-        process.stdin.resume()
-        process.stdin.pause()
-      }
-
-      if (error && !options.ignoreErrors) {
-        error.stdout = stdout
-        error.stderr = stderr
-
-        var errorContext = _.extend({
-          command: command,
-          file: file,
-          error: error
-        }, options.templateData)
+      shell: true,
+      stdio: options.quiet ? 'ignore' : 'inherit'
+    })
 
-        error.message = gutil.template(options.errorMessage, errorContext)
+    child.on('exit', function (code) {
+      if (code === 0 || options.ignoreErrors) {
+        return done()
       }
 
-      done(options.ignoreErrors ? null : error)
-    })
+      var context = _.extend({
+        command: command,
+        file: file,
+        error: {code: code}
+      }, options.templateData)
 
-    if (options.interactive) {
-      process.stdin.resume()
-      process.stdin.setEncoding('utf8')
-      process.stdin.pipe(child.stdin)
-    }
+      var message = gutil.template(options.errorMessage, context)
 
-    if (!options.quiet) {
-      child.stdout.pipe(process.stdout)
-      child.stderr.pipe(process.stderr)
-    }
+      done(new gutil.PluginError(PLUGIN_NAME, message))
+    })
   }, done)
 }
 
@@ -97,10 +79,7 @@ function shell (commands, options) {
 
     runCommands(commands, options, file, function (error) {
       if (error) {
-        self.emit('error', new gutil.PluginError({
-          plugin: PLUGIN_NAME,
-          message: error.message
-        }))
+        self.emit('error', error)
       } else {
         self.push(file)
       }

test/index.js

@@ -6,13 +6,10 @@ var expect = require('chai').expect
 
 var shell = require('..')
 
-var originalStdoutWrite = process.stdout.write
-function expectToOutput (expected, done) {
-  process.stdout.write = function (actual) {
-    process.stdout.write = originalStdoutWrite
-    expect(actual.toLowerCase()).to.include(expected.toLowerCase())
-    done()
-  }
+function expectToBeOk (stream, done) {
+  stream
+  .on('error', done)
+  .on('data', function () { done() })
 }
 
 describe('gulp-shell(commands, options)', function () {
@@ -42,17 +39,21 @@ describe('gulp-shell(commands, options)', function () {
   })
 
   it('executes command after interpolation', function (done) {
-    var stream = shell(['echo <%= file.path %>'])
+    var stream = shell([
+      'test <%= file.path %> = ' + fakeFile.path
+    ])
 
-    expectToOutput(fakeFile.path, done)
+    expectToBeOk(stream, done)
 
     stream.write(fakeFile)
   })
 
   it('prepends `./node_modules/.bin` to `PATH`', function (done) {
-    var stream = shell(['echo $PATH'])
+    var stream = shell([
+      'echo $PATH | grep -q "' + join(process.cwd(), 'node_modules/.bin') + '"'
+    ])
 
-    expectToOutput(join(process.cwd(), 'node_modules/.bin'), done)
+    expectToBeOk(stream, done)
 
     stream.write(fakeFile)
   })
@@ -62,9 +63,8 @@ describe('gulp-shell(commands, options)', function () {
       var task = shell.task(['echo hello world'])
 
       expect(task).to.be.a('function')
-      expectToOutput('hello world', done)
 
-      task()
+      task(done)
     })
   })
 
@@ -99,23 +99,7 @@ describe('gulp-shell(commands, options)', function () {
       it("won't output anything when `quiet` == true", function (done) {
         var stream = shell(['echo cannot see me!'], {quiet: true})
 
-        expectToOutput('this should not match anything!', done)
-
-        stream.on('data', function () {
-          process.stdout.write = originalStdoutWrite
-          done()
-        })
-
-        stream.write(fakeFile)
-      })
-    })
-
-    describe('interactive', function () {
-      it('reads input when `interactive` == true', function (done) {
-        var stream = shell(['read s; echo $s'], {interactive: true})
-
-        process.stdin.push('something\n')
-        expectToOutput('something', done)
+        expectToBeOk(stream, done)
 
         stream.write(fakeFile)
       })
@@ -150,17 +134,21 @@ describe('gulp-shell(commands, options)', function () {
 
     describe('cwd', function () {
       it('sets the current working directory when `cwd` is a string', function (done) {
-        var stream = shell(['pwd'], {cwd: '..'})
+        var stream = shell([
+          'test $PWD = ' + join(__dirname, '../..')
+        ], {cwd: '..'})
 
-        expectToOutput(join(__dirname, '../..'), done)
+        expectToBeOk(stream, done)
 
         stream.write(fakeFile)
       })
 
       it('uses the process current working directory when `cwd` is not passed', function (done) {
-        var stream = shell(['pwd'])
+        var stream = shell([
+          'test $PWD = ' + join(__dirname, '..')
+        ])
 
-        expectToOutput(join(__dirname, '..'), done)
+        expectToBeOk(stream, done)
 
         stream.write(fakeFile)
       })