gulp.src(globs[, options])
Emits files matching provided glob or an array of globs. Returns a stream of Vinyl files that can be piped to plugins.
gulp.src('client/templates/*.jade')
.pipe(jade())
.pipe(minify())
.pipe(gulp.dest('build/minified_templates'));
globs
Type: String or Array
要读取的glob或glob数组。Globs使用node-glob语法，除此之外它还支持取反。以!开头的glob从结果中排除匹配的文件。
options
Type: Object
通过glob-stream传递给 node-glob的选项。
gulp支持除ignore之外所有node-glob支持的选项 和 glob-stream支持的选项，并且还支持以下选项：
options.buffer
Type: Boolean
Default: true
Setting this to false will return file.contents as a stream and not buffer files. This is useful when working with large files.Note: Plugins might not implement support for streams.
options.read
Type: Boolean
Default: true
Setting this to false will return file.contents as null and not read the file at all.
options.base
Type: String
Default: everything before a glob starts (see glob2base)
E.g., 考虑client/js/somedir中的somefile.js：
gulp.src('client/js/**/*.js') // 匹配'client/js/somedir/somefile.js'并将`base`解析为`client/js/`
.pipe(minify())
.pipe(gulp.dest('build')); //写入'build/somedir/somefile.js'
gulp.src('client/js/**/*.js', { base: 'client' })
.pipe(minify())
.pipe(gulp.dest('build')); // 写入'build/js/somedir/somefile.js'
gulp.dest(path[, options])
Can be piped to and it will write files. Re-emits all data passed to it so you can pipe to multiple folders. Folders that don't exist will be created.
gulp.src('./client/templates/*.jade')
.pipe(jade())
.pipe(gulp.dest('./build/templates'))
.pipe(minify())
.pipe(gulp.dest('./build/minified_templates'));
写入路径是通过把文件相对路径添加到给出的目的目录后得出的。反过来说，相对路径是相对于文件base的。详细查看上面的gulp.src。
path
Type: String or Function
写入文件的路径（输出文件夹）。或者是一个返回路径的函数，函数必须提供一个vinyl File instance.
options
Type: Object
options.cwd
Type: String
Default: process.cwd()
cwd for the output folder, only has an effect if provided output folder is relative.
options.mode
Type: String
Default: 0777
指明任何需要创建的文件夹模式的八进制权限字符串。
gulp.task(name [, deps, fn])
使用Orchestrator定义一个任务。
gulp.task('somename', function() {
// Do stuff
});
name
Type: String
任务的名称。在命令行中输入的任务名称之间要有空格。
deps
Type: Array
在你的任务执行前要执行并结束的一个任务组。
gulp.task('mytask', ['array', 'of', 'task', 'names'], function() {
// Do stuff
});
注意：你的任务是在依赖任务结束前运行的吗？要保证你的依赖任务正确使用异步运行提示：接受一个回调函数或返回一个promise或事件流。
如果你仅想执行一系列任务，你可以忽略函数：
gulp.task('build', ['array', 'of', 'task', 'names']);
注意：这些任务会并行执行（同时），因此不要以为他们会依次开始或结束。
fn
Type: Function
这个函数执行任务的主要操作。一般来说会是以下形式：
gulp.task('buildStuff', function() {
// Do something that "builds stuff"
var stream = gulp.src(/*some source path*/)
.pipe(somePlugin())
.pipe(someOtherPlugin())
.pipe(gulp.dest(/*some destination*/));
return stream;
});
异步任务支持
如果该函数有以下特性，那么这个任务就是异步的。
接受一个回调函数
// run a command in a shell
var exec = require('child_process').exec;
gulp.task('jekyll', function(cb) {
// build Jekyll
exec('jekyll build', function(err) {
if (err) return cb(err); // return error
cb(); // finished task
});
});
返回一个流
gulp.task('somename', function() {
var stream = gulp.src('client/**/*.js')
.pipe(minify())
.pipe(gulp.dest('build'));
return stream;
});
返回一个promise
var Q = require('q');
gulp.task('somename', function() {
var deferred = Q.defer();
// do async stuff
setTimeout(function() {
deferred.resolve();
}, 1);
return deferred.promise;
});
注意： 默认情况下，任务以最大的并行性运行。——例如，它同时启动所有任务，不做等待。如果你想创建一系列按需执行的任务，你需要做两件事：
- 给一个提示表明任务结束
- 并且给出一个任务依赖另一个任务的提示
对下面的例子，我们假设你有两个任务，你希望他们顺序执行。
- 在任务one中你添加一个表明任务结束的提示。Either take in a callback and call it when you're done or return a promise or stream that the engine should wait to resolve or end respectively.
- 在任务two中你添加一个提示，说明它依赖任务one的完成。
因此，任务代码如下：
var gulp = require('gulp');
//接受一个回调函数以让引擎知道它何时结束
gulp.task('one', function(callback) {
// do stuff -- async or otherwise
callback(err); // if err is not null and not undefined, the run will stop, and note that it failed
});
// 指明在这个任务开始前依赖任务必须完成
gulp.task('two', ['one'], function() {
//任务one现在完成了
});
gulp.task('default', ['one', 'two']);
gulp.watch(glob [, opts], tasks) or gulp.watch(glob [, opts, cb])
监听文件变化，并执行一些动作。This always returns an EventEmitter that emits change events.
gulp.watch(glob[, opts], tasks)
glob
Type: String or Array
用来指明哪些文件要监测的glob或者glob数组。
opts
Type: Object
传递给gaze的配置选项。
tasks
Type: Array
当文件改变时需要执行的任务的名称。
var watcher = gulp.watch('js/**/*.js', ['uglify','reload']);
watcher.on('change', function(event) {
console.log('File ' + event.path + ' was ' + event.type + ', running tasks...');
});
gulp.watch(glob[, opts, callback])
glob
Type: String or Array
用来指明哪些文件要监测的glob或者glob数组。
opts
Type: Object
传递给gaze的配置选项。
callback(event)
Type: Function
每次发生改变都会调用的函数。
gulp.watch('js/**/*.js', function(event) {
console.log('File ' + event.path + ' was ' + event.type + ', running tasks...');
});
回调函数被传递一个event对象，用来描述这次改变：
event.type
Type: String
发生的改变的类型：added、changed或deleted。
event.path
Type: String
触发这个事件的文件的路径。
