1. gulp.src(globs[, options])
Grunt.js和Gulp.js工作方式
Grunt主要是以文件为媒介来运行它的工作流的,比如在Grunt中执行完一项任务后,会把结果写入到一个临时文件中,然后可以在这个临时文件内容的基础上执行其它任务,执行完成后又把结果写入到临时文件中,然后又以这个为基础继续执行其它任务...就这样反复下去。
而在Gulp中,使用的是Nodejs中的stream(流),首先获取到需要的stream,然后可以通过stream的
pipe()
方法把流导入到你想要的地方,比如Gulp的插件中,经过插件处理后的流又可以继续导入到其他插件中,当然也可以把流写入到文件中。
gulp.src()
方法正是用来获取流的,但要注意这个流里的内容不是原始的文件流,而是一个虚拟文件对象流(Vinyl files),这个虚拟文件对象中存储着原始文件的路径、文件名、内容等信息。
语法:
gulp.src(globs[, options])
- globs
- 类型:
String
或Array
- 描述: 所要读取的 glob 或者包含 globs 的数组。
- 类型:
这个参数是文件匹配模式(类似正则表达式),用来匹配文件路径(包括文件名),当然这里也可以直接指定某个具体的文件路径。当有多个匹配模式时,该参数可以为一个数组。
- options[可选参数]
- 类型:`Object-
- 描述:通过 glob-stream 所传递给 node-glob 的参数。
- options.buffer
- 类型:
Boolean
默认值:true
- 如果该项被设置为 false,那么将会以 stream 方式返回 file.contents 而不是文件 buffer 的形式。这在处理一些大文件的时候将会很有用。注意:插件可能并不会实现对 stream 的支持。
- 类型:
- options.read
- 类型:
Boolean
默认值:true
- 如果该项被设置为 false, 那么 file.contents 会返回空值(null),也就是并不会去读取文件。
- 类型:
- options.base
- 类型: String
- 默认值: 将会加在 glob 之前
如, 请想像一下在一个路径为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' 用'build'替换base
gulp.src('client/js/**/*.js', { base: 'client' })
.pipe(minify())
.pipe(gulp.dest('build'));
// 写入 'build/js/somedir/somefile.js'用'build'替换base
2. gulp.dest(path[, options])
- path
- 类型:
String
orFunction
- 文件将被写入的路径(输出目录)。也可以传入一个函数,在函数中返回相应路径,这个函数也可以由 vinyl 文件实例 来提供。
- 类型:
- options [可选参数]
gulp的使用流程一般是这样子的:首先通过gulp.src()
方法获取到我们想要处理的文件流,然后把文件流通过pipe方法导入到gulp的插件中,最后把经过插件处理后的流再通过pipe方法导入到gulp.dest()
中,gulp.dest()
方法则把流中的内容写入到文件中,这里首先需要弄清楚的一点是,我们给gulp.dest()
传入的路径参数,只能用来指定要生成的文件的目录,而不能指定生成文件的文件名,它生成文件的文件名使用的是导入到它的文件流自身的文件名。
所以 生成的文件名是由导入到它的文件流决定的,即使我们给它传入一个带有文件名的路径参数,然后它也会把这个文件名当做是目录名,要想改变文件名,可以使用插件gulp-rename
gulp.dest(path)
生成的文件路径是我们传入的path参数后面再加上gulp.src()
中有通配符开始出现的那部分路径。例如:
var gulp = reruire('gulp');
//有通配符开始出现的那部分路径为 **/*.js
gulp.src('script/**/*.js')
.pipe(gulp.dest('dist')); //最后生成的文件路径为 dist/**/*.js
//如果 **/*.js 匹配到的文件为 jquery/jquery.js ,则生成的文件路径为 dist/jquery/jquery.js
用gulp.dest()
把文件流写入文件后,文件流仍然可以继续使用。
3.gulp.task(name[, deps], fn)
定义一个使用 Orchestrator 实现的任务(task)。
gulp.task('somename', function() {
// 做一些事
});
- name:任务的名字,如果你需要在命令行中运行你的某些任务,那么,请不要在名字中使用空格。
- deps:一个包含任务列表的数组,这些任务会在你当前任务运行之前完成。
gulp.task('mytask', ['array', 'of', 'task', 'names'], function() {
// 做一些事
});
- fn:该函数定义任务所要执行的一些操作。通常来说,它会是这种形式:
gulp.src().pipe(someplugin())
。
异步任务支持
有三种方法可以实现任务异步执行:
- 接受一个 callback
gulp.task('one',function(cb){
//one是一个异步执行的任务
setTimeout(function(){
console.log('one is done')
cb(); //执行回调,表示这个异步任务已经完成
},5000);
});
//这时two任务会在one任务中的异步操作完成后再执行执行
gulp.task('two',['one'],function(){
console.log('two is done');
});
- 返回一个 stream(流)对象
gulp.task('one',function(cb){
var stream = gulp.src('client/**/*.js')
.pipe(dosomething()) //dosomething()中有某些异步操作
.pipe(gulp.dest('build'));
return stream;
});
gulp.task('two',['one'],function(){
console.log('two is done');
});
- 返回一个promise对象,例如
var Q = require('q'); //一个著名的异步处理的库 https://github.com/kriskowal/q
gulp.task('one',function(cb){
var deferred = Q.defer();
// 做一些异步操作
setTimeout(function() {
deferred.resolve();
}, 5000);
return deferred.promise;
});
gulp.task('two',['one'],function(){
console.log('two is done');
});
4. gulp.watch(glob [, opts], tasks) 或 gulp.watch(glob [, opts, cb])
用来监视文件的变化,当文件发生变化后,我们可以利用它来执行相应的任务,例如文件压缩等。
gulp.watch(glob[, opts], tasks)
- glob 为要监视的文件匹配模式,规则和用法与gulp.src()方法中的glob相同。
- opts 为一个可选的配置对象,通常不需要用到
- tasks 为文件变化后要执行的任务,为一个数组
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])
cb参数为一个函数。每当监视的文件发生变化时,就会调用这个函数,并且会给它传入一个对象,该对象包含了文件变化的一些信息,type
属性为变化的类型,可以是added
,changed
,deleted
;path
属性为发生变化的文件的路径
gulp.watch('js/**/*.js', function(event){
console.log(event.type); //变化类型 added为新增,deleted为删除,changed为改变
console.log(event.path); //变化的文件的路径
});