API 文档

1、gulp.src(globs[, options])

输出(Emits)符合所提供的匹配模式(glob)或匹配模式数组的文件,返回一个 Vinyl files 的 stream 它可以被 piped 到别的插件中;

globs

类型:string 或 array
意思:要读取的匹配模式或者包含匹配模式的数组
语法:请参考 node-glob 语法 或者,你也可以直接写文件的路径。

options

类型:object
通过 glob-stream 所传递给 node-glob 的参数。
除了 node-glob 和 glob-stream 所支持的参数外,gulp 增加了一些额外的选项参数:

  • options.buffer
    类型: Boolean 默认值: true
    如果该项被设置为 false,那么将会以 stream 方式返回 file.contents 而不是文件 buffer 的形式。
    这在处理一些大文件的时候将会很有用。注意:插件可能并不会实现对 stream 的支持。
  • options.read
    类型: Boolean 默认值: true
    如果该项被设置为 false, 那么 file.contents 会返回空值(null),也就是并不会去读取文件。
  • options.base
    类型: String 默认值: 将会加在 glob 之前 (请看 glob2base)

如, 请想像一下在一个路径为 client/js/somedir 的目录中,有一个文件叫 somefile.js :

gulp.src('client/js/**/*.js')  // 匹配 'client/js/' 下的所有 js 文件,并将 'base' 解析为 'client/js/'
  .pipe(minify())  // 传输到 minify 插件
  .pipe(gulp.dest('build'));  // 写入 'build/' 对应的文件位置

gulp.src('client/js/**/*.js', { base: 'client' }) // 'base' 解析为 'client'
  .pipe(minify())
  .pipe(gulp.dest('build'));  // 写入 'build/js/' 对应的文件位置

2、gulp.dest(path[, options])

能被 pipe 进来,并且将会写文件,并重新输出所有数据
因此可以将它 pipe 到多个文件夹
如果文件夹不存在,将会自动创建它

gulp.src('./client/templates/*.jade')
  .pipe(jade())
  .pipe(gulp.dest('./build/templates'))
  .pipe(minify())
  .pipe(gulp.dest('./build/minified_templates'));

文件被写入的路径是根据 base 计算而来的

path

类型:string 和 function
文件将被写入的路径(输入目录),、
也可以传递一个函数,在函数中返回相应路径,这个函数可以由 vinyl 文件实例 来提供

options

类型:object

  • options.cwd
    类型:string 默认值:process.cwd()
    输出目录的 cwd 参数,只在所给的输出目录是相对路径时有效
  • options.mode
    类型:string 默认值:0777
    八进制权限字符,用以定义所在输出目录中所创建的目录的权限

3、gulp.task(name[, deps], fn)

定义一个使用 Orchestrator 实现的任务(task)。

name

类型:string
任务名,不要使用空格

deps

类型:array
一个包含前置依赖任务列表的数组,这些任务会在你当前任务运行之前完成

gulp.task('mytask', ['array', 'of', 'task', 'names'], function() {
  // 做一些事
});

注意:
你的任务是否在前置依赖任务完成之前运行了?
一定要确保所依赖列表中的任务都使用了正确的异步执行方式:使用一个 callback,或者返回一个 promise 或 stream

fn

定义任务所要执行的操作
通常来说,它会以这种形式:gulp.src().pipe(someplugin())

异步任务支持
如果 fn 可以坐到以下其中一点,任务可以异步执行:

  1. 接受一个 callback
    // 在 shell 中执行一个命令
    var exec = require('child_process').exec;
    gulp.task('jekyll', function(cb) {
        // 编译 Jekyll
        exec('jekyll build', function(err) {
          if (err) return cb(err); // 返回 error
          cb(); // 完成 task
        });
    });
    
2. 返回一个 stream
gulp.task('somename', function() {
  var stream = gulp.src('client/**/*.js')
    .pipe(minify())
    .pipe(gulp.dest('build'));
  return stream;
});
3. 返回一个 promise
var Q = require('q');
gulp.task('somename', function() {
  var deferred = Q.defer();
  // 执行异步的操作
  setTimeout(function() {
    deferred.resolve();
  }, 1);
  return deferred.promise;
});

** 注意: **
默认的,task 将以最大并发数执行, 就是说,gulp 会一次性运行所有的 task 并且不做任何等待;
如果想创建一个序列化的 task 队列,以指定顺序执行,需要完成下面两件事:
- 给出一个提示,告知 task 什么时候执行完毕
- 给出一个提示,告知一个 task 依赖另一个 task 的完成

假设有两个 task,"one" 和 "two",并且你希望它们按照先后顺序执行
1. 在 "one" 中,加入一个提示,告知什么时候完成:可以在完成时返回一个 callback、promise 或者 stream,这样系统会等待它完成;
2. 在 "two" 中,你需要添加一个提示来告诉它需要依赖第一个 task 完成;

example:

var gulp = require('gulp');
//返回一个 callback,让系统知道它什么时候完成
gulp.task('one', function(cb) {
// 做一些事
if(err) cb(err);// 如果 err 不是 null 或 undefined,则会停止执行,且注意,这样代表执行失败了
cb();
});
// 定义一个依赖,必须在当前 task 执行之前完成
gulp.task('two', ['one'], function() {
// 'one' 完成之后
});
gulp.task('default', ['one', 'two']);



## 4、gulp.watch(glob[, opts], tasks) 或 gulp.watch(glob[, opts, cb])
监视文件,并且可以在文件发生改动的时候做一些事情;
总会返回一个 EventEmitter 来发射(emit)change 事件;
#### gulp.watch(glob[, opts], tasks) 
**glob**
类型:string 和 array
用来指定具体监控哪些文件的变动;

**opts**
类型:object
传给 [gaze](https://github.com/shama/gaze) 的参数

**tasks**
类型:array
需要在文件变动后执行一个或多个 task 任务的名字

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, cb])
**glob**
类型:string 和 array
用来指定具体监控哪些文件的变动;

**opts**
类型:object
传给 [gaze](https://github.com/shama/gaze) 的参数

**cb(even)**
类型:function
每次变动需要执行的 callback

gulp.watch('js/*/.js', function(event) {
console.log('File ' + event.path + ' was ' + event.type + ', running tasks...');
});

callback 会被传入一个 event 对象,这个对象描述了所监控到的变动

event.type
类型:string
发生变动的类型:added,changed 或者 deleted

event.path
类型:string
触发了该事件的文件路径



















。

你可能感兴趣的:(API 文档)