Package Exports
- gulp-shell
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gulp-shell) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
gulp-shell
A handy command line interface for gulp
Installation
npm install --save-dev gulp-shellUsage
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'
]))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.
options.env
type: Object
default: process.env with PATH prepended by ./node_modules/.bin, allowing you to run executables in your Node's dependencies.