1 gulp.src(globs[, options])
作用:globs可能是一個字符串或者一個數組,它包含一個或多個文件路徑。gulp.src會把這些文件變成文件流,供后續使用。如:經過不同作用的插件管道來達到不同的文件處理的目的。
gulp.src('client/templates/*.jade')
.pipe(jade())
.pipe(minify())
.pipe(gulp.dest('build/minified_templates'));
globs
類型: String 或 Array
所要讀取的 glob 或者包含 globs 的數組。
舉個例子,看下面的文件結構:
client/
a.js
bob.js
bad.js
下面的表達式是匹配a.js和bad.js
gulp.src(['client/*.js', '!client/b*.js', 'client/bad.js'])
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/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'
2 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'));
文件被寫入的路徑是以所給的相對路徑根據所給的目標目錄計算而來。類似的,相對路徑也可以根據所給的 base 來計算。
path
類型:String or Function
文件將被寫入的路徑(輸出目錄)。也可以傳入一個函數,在函數中返回相應路徑,這個函數也可以由 vinyl 文件實例 來提供。
options
類型: Object
#######options.cwd
類型: String 默認值: process.cwd()
輸出目錄的 cwd 參數,只在所給的輸出目錄是相對路徑時候有效。
options.mode
類型: String 默認值: 0777
八進制權限字符,用以定義所有在輸出目錄中所創建的目錄的權限。
3 gulp.task(name[, deps], fn)
定義一個使用 Orchestrator 實現的任務(task)。
gulp.task('somename', function() {
// 做一些事
});
name
任務的名字,如果你需要在命令行中運行你的某些任務,那么,請不要在名字中使用空格。
deps
類型: Array
一個包含任務列表的數組,這些任務會在你當前任務運行之前完成。
gulp.task('mytask', ['array', 'of', 'task', 'names'], function() {
// 做一些事
});
注意: 你的任務是否在這些前置依賴的任務完成之前運行了?請一定要確保你所依賴的任務列表中的任務都使用了正確的異步執行方式:使用一個 callback,或者返回一個 promise 或 stream。
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 將以最大的并發數執行,也就是說,gulp 會一次性運行所有的 task 并且不做任何等待。如果你想要創建一個序列化的 task 隊列,并以特定的順序執行,你需要做兩件事:
1: 給出一個提示,來告知 task 什么時候執行完畢,
2: 并且再給出一個提示,來告知一個 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']);
4 gulp.watch(glob [, opts], tasks) 或 gulp.watch(glob [, opts, cb])
監視文件,并且可以在文件發生改動時候做一些事情。它總會返回一個 EventEmitter 來發射(emit) change 事件。
4.1 gulp.watch(glob[, opts], tasks)
glob
類型: String or Array
一個 glob 字符串,或者一個包含多個 glob 字符串的數組,用來指定具體監控哪些文件的變動。
opts
類型:Object
傳給 gaze
的參數。
task
類型: Array
需要在文件變動后執行的一個或者多個通過 gulp.task() 創建的 task 的名字
var watcher = gulp.watch('js/**/*.js', ['uglify','reload']);
watcher.on('change', function(event) {
console.log('File ' + event.path + ' was ' + event.type + ', running tasks...');
});
4.2 gulp.watch(glob[, opts, cb])
glob
類型: String or Array
一個 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...');
});
callback 會被傳入一個名為 event 的對象。這個對象描述了所監控到的變動:
event.type
類型: String
發生的變動的類型:added, changed 或者 deleted。
event.path
類型: String
觸發了該事件的文件的路徑。