gulp API 文档 | 易学教程

gulp.src(globs[, options])

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

globs

StringArray

所要读取的 glob 或者包含 globs 的数组。

options

Object

glob-stream node-glob

node-glob glob-stream

options.buffer

Booleantrue

falsefile.contents

options.read

Booleantrue

falsefile.contents

options.base

Stringglob2base)

client/js/somedirsomefile.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])

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

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

gulp.src

path

StringFunction

vinyl 文件实例

options

Object

options.cwd

Stringprocess.cwd()

cwd

options.mode

String0777

八进制权限字符，用以定义所有在输出目录中所创建的目录的权限。

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

Orchestrator

gulp.task('somename', function() {   // 做一些事 });

name

任务的名字，如果你需要在命令行中运行你的某些任务，那么，请不要在名字中使用空格。

deps

Array

一个包含任务列表的数组，这些任务会在你当前任务运行之前完成。

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

fn

该函数定义任务所要执行的一些操作。通常来说，它会是这种形式：gulp.src().pipe(someplugin())。

异步任务支持

fn

接受一个 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   }); });

返回一个 stream

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();    // 执行异步的操作   setTimeout(function() {     deferred.resolve();   }, 1);    return deferred.promise; });

给出一个提示，来告知 task 什么时候执行完毕，
并且再给出一个提示，来告知一个 task 依赖另一个 task 的完成。

对于这个例子，让我们先假定你有两个 task，"one" 和 "two"，并且你希望它们按照这个顺序执行：

在 "one" 中，你加入一个提示，来告知什么时候它会完成：可以再完成时候返回一个 callback，或者返回一个 promise 或 stream，这样系统会去等待它完成。
在 "two" 中，你需要添加一个提示来告诉系统它需要依赖第一个 task 完成。

因此，这个例子的实际代码将会是这样：

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

gulp.watch(glob [, opts], tasks) 或 gulp.watch(glob [, opts, cb])

change

gulp.watch(glob[, opts], tasks)

glob

StringArray

一个 glob 字符串，或者一个包含多个 glob 字符串的数组，用来指定具体监控哪些文件的变动。

opts

Object

gaze

tasks

Array

gulp.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

StringArray

一个 glob 字符串，或者一个包含多个 glob 字符串的数组，用来指定具体监控哪些文件的变动。

opts

Object

gaze

cb(event)

Function

每次变动需要执行的 callback。

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

event

event.type

String

发生的变动的类型：addedchangeddeleted。

event.path

String

触发了该事件的文件的路径。

本文参考来源：https://www.gulpjs.com.cn/docs/api/

标签

gulp

pipe

event