gulp-shell

gulp-shell

A handy command line interface for gulp

Installation

npm install --save-dev gulp-shell

Usage

var gulp  = require('gulp')
var shell = require('gulp-shell')

gulp.task('example', function () {
  return gulp.src('*.js', {read: false})
    .pipe(shell([
      'echo <%= f(file.path) %>',
      'ls -l <%= file.path %>'
    ], {
      templateData: {
        f: function (s) {
          return s.replace(/$/, '.bak')
        }
      }
    }))
})

If you just want to execute a series of commands only once, starting the stream with gulp.src('') should do the trick.

Or you can use this shorthand:

gulp.task('shorthand', shell.task([
  'echo hello',
  'echo world'
]))

Note: All the commands will be executed in an environment where PATH prepended by ./node_modules/.bin, allowing you to run executables in your Node's dependencies.

You can find more examples in the gulpfile of this project.

API

shell(commands, options) or shell.task(commands, options)

commands

type: Array or String

A command can be a template which can be interpolated by some file info (e.g. file.path).

options.ignoreErrors

type: Boolean

default: false

By default, it will emit an error event when the command finishes unsuccessfully.

options.quiet

type: Boolean

default: false

By default, it will print the command output.

options.cwd

type: String

default: process.cwd()

Sets the current working directory for the command.

options.templateData

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.