gulp API

1 gulp.src(globs[, options])

作用:globs可能是一個字符串或者一個數(shù)組,它包含一個或多個文件路徑。gulp.src會把這些文件變成文件流,供后續(xù)使用。如:經(jīng)過不同作用的插件管道來達到不同的文件處理的目的。

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

globs

類型: String 或 Array
所要讀取的 glob 或者包含 globs 的數(shù)組。
舉個例子,看下面的文件結(jié)構(gòu):

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 的參數(shù)。
除了 node-globglob-stream 所支持的參數(shù)外,gulp 增加了一些額外的選項參數(shù):

options.buffer

類型: Boolean 默認(rèn)值: true

如果該項被設(shè)置為 false,那么將會以 stream 方式返回 file.contents 而不是文件 buffer 的形式。這在處理一些大文件的時候?qū)苡杏谩?strong>注意:插件可能并不會實現(xiàn)對 stream 的支持。

options.read

類型: Boolean 默認(rèn)值: true

如果該項被設(shè)置為 false, 那么 file.contents 會返回空值(null),也就是并不會去讀取文件。

options.base

類型:String
默認(rèn)值: 將會加在 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)所有數(shù)據(jù),因此你可以將它 pipe 到多個文件夾。如果某文件夾不存在,將會自動創(chuàng)建它。

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

文件被寫入的路徑是以所給的相對路徑根據(jù)所給的目標(biāo)目錄計算而來。類似的,相對路徑也可以根據(jù)所給的 base 來計算。

path

類型:String or Function

文件將被寫入的路徑(輸出目錄)。也可以傳入一個函數(shù),在函數(shù)中返回相應(yīng)路徑,這個函數(shù)也可以由 vinyl 文件實例 來提供。

options

類型: Object
#######options.cwd
類型: String 默認(rèn)值: process.cwd()

輸出目錄的 cwd 參數(shù),只在所給的輸出目錄是相對路徑時候有效。

options.mode

類型: String 默認(rèn)值: 0777

八進制權(quán)限字符,用以定義所有在輸出目錄中所創(chuàng)建的目錄的權(quán)限。

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

定義一個使用 Orchestrator 實現(xiàn)的任務(wù)(task)。

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

name

任務(wù)的名字,如果你需要在命令行中運行你的某些任務(wù),那么,請不要在名字中使用空格。

deps

類型: Array

一個包含任務(wù)列表的數(shù)組,這些任務(wù)會在你當(dāng)前任務(wù)運行之前完成。

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

注意: 你的任務(wù)是否在這些前置依賴的任務(wù)完成之前運行了?請一定要確保你所依賴的任務(wù)列表中的任務(wù)都使用了正確的異步執(zhí)行方式:使用一個 callback,或者返回一個 promise 或 stream。

fn

該函數(shù)定義任務(wù)所要執(zhí)行的一些操作。通常來說,它會是這種形式:gulp.src().pipe(someplugin())。
異步任務(wù)支持

任務(wù)可以異步執(zhí)行,如果 fn 能做到以下其中一點:
接受一個 callback

// 在 shell 中執(zhí)行一個命令
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();

  // 執(zhí)行異步的操作
  setTimeout(function() {
    deferred.resolve();
  }, 1);

  return deferred.promise;
});

注意: 默認(rèn)的,task 將以最大的并發(fā)數(shù)執(zhí)行,也就是說,gulp 會一次性運行所有的 task 并且不做任何等待。如果你想要創(chuàng)建一個序列化的 task 隊列,并以特定的順序執(zhí)行,你需要做兩件事:

1: 給出一個提示,來告知 task 什么時候執(zhí)行完畢,
2: 并且再給出一個提示,來告知一個 task 依賴另一個 task 的完成。

對于這個例子,讓我們先假定你有兩個 task,"one" 和 "two",并且你希望它們按照這個順序執(zhí)行:
第一步:在 "one" 中,你加入一個提示,來告知什么時候它會完成:可以再完成時候返回一個 callback,或者返回一個 promise 或 stream,這樣系統(tǒng)會去等待它完成。
第二步:在 "two" 中,你需要添加一個提示來告訴系統(tǒng)它需要依賴第一個 task 完成。

因此,這個例子的實際代碼將會是這樣:

var gulp = require('gulp');

// 返回一個 callback,因此系統(tǒng)可以知道它什么時候完成
gulp.task('one', function(cb) {
    // 做一些事 -- 異步的或者其他的
    cb(err); // 如果 err 不是 null 或 undefined,則會停止執(zhí)行,且注意,這樣代表執(zhí)行失敗了
});

// 定義一個所依賴的 task 必須在這個 task 執(zhí)行之前完成
gulp.task('two', ['one'], function() {
    // 'one' 完成后
});

gulp.task('default', ['one', 'two']);

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

監(jiān)視文件,并且可以在文件發(fā)生改動時候做一些事情。它總會返回一個 EventEmitter 來發(fā)射(emit) change 事件。

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

glob

類型: String or Array

一個 glob 字符串,或者一個包含多個 glob 字符串的數(shù)組,用來指定具體監(jiān)控哪些文件的變動。

opts

類型:Object

傳給 gaze
的參數(shù)。

task

類型: Array

需要在文件變動后執(zhí)行的一個或者多個通過 gulp.task() 創(chuàng)建的 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 字符串的數(shù)組,用來指定具體監(jiān)控哪些文件的變動。

opts

類型:Object

傳給 gaze
的參數(shù)。

cb(event)

類型: Function

每次變動需要執(zhí)行的 callback。

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

callback 會被傳入一個名為 event 的對象。這個對象描述了所監(jiān)控到的變動:

event.type

類型: String

發(fā)生的變動的類型:added, changed 或者 deleted。

event.path

類型: String

觸發(fā)了該事件的文件的路徑。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • 1. gulp.src(globs[, options]) Grunt.js和Gulp.js工作方式 Grunt主...
    angelwgh閱讀 352評論 0 0
  • gulp.src(globs[, options]) Emits files matching provided ...
    JasonQiao閱讀 723評論 0 0
  • gulpjs是一個前端構(gòu)建工具,與gruntjs相比,gulpjs無需寫一大堆繁雜的配置參數(shù),API也非常簡單,學(xué)...
    依依玖玥閱讀 3,299評論 7 55
  • 1、gulp的安裝 首先確保你已經(jīng)正確安裝了nodejs環(huán)境。然后以全局方式安裝gulp: npm install...
    F_imok閱讀 2,474評論 1 11
  • gulpjs是一個前端構(gòu)建工具,與gruntjs相比,gulpjs無需寫一大堆繁雜的配置參數(shù),API也非常簡單,學(xué)...
    井皮皮閱讀 1,393評論 0 10

友情鏈接更多精彩內(nèi)容