gulp教程之API

gulp API

gulp.src(globs[,options])

输出符合所提供的匹配模式的文件,将返回的的文件的stream可以被piped到别的插件中。

1
2
3
4
gulp.src('client/templates/*.jade')
.pipe(jade())
.pipe(minify())
.pipe(gulp.dest('build/minified_templates'));
参数说明
globs需要处理的源文件匹配符路径
options有3个属性buffer、read、base

globs的文件匹配说明:

“src/a.js”:指定具体文件;

  • *:匹配所有文件 例:src/*.js(包含src下的所有js文件);
  • “**”:匹配0个或多个子文件夹 例:src/**/*.js(包含src的0个或多个子文件夹下的js文件);
  • “{}”:匹配多个属性 例:src/{a,b}.js(包含a.js和b.js文件) src/*.{jpg,png,gif}(src下的所有jpg/png/gif文件);
  • “!”:排除文件 例:!src/a.js(不包含src下的a.js文件);
1
2
3
4
5
6
7
vargulp= require('gulp'),

gulp.task('test', function () {
//gulp.src('test/style.css')
gulp.src(['css/**/*.css','!css/{extend,page}/*.css'])
.pipe(gulp.dest('./css'));
});

options 的三个属性说明

参数类型默认说明
options.bufferBooleantrue设置为false,将返回file.content的流并且不缓冲文件,处理大文件时非常有用;
options.readBooleantrue设置false,将不执行读取文件操作,返回null;
options.baseString设置输出路径以某个路径的某个组成部分为基础向后拼接

gulp.dest(path[,options])

dest()方法是指定处理完成后文件输出的路径

参数说明
path指定文件输出路径,或者定义函数返回文件输出路径亦可
options有2个属性cwd、mode
1
2
3
4
5
6
vargulp= require('gulp');

gulp.task('testtask', function() {
gulp.src('./js/test.js')
.pipe(gulp.dest('./build'));
});

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

该方法用于定义一个gulp任务。

参数说明
name任务名称,不能包含空格
deps该任务依赖的任务,依赖任务的执行顺序跟在deps中声明的顺序一致
fn该任务调用的插件操作
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
vargulp= require('gulp');

gulp.task('task1',function(){
console.log('task1 done');
});

gulp.task('task2',function(){
console.log('task2 done!');
});

gulp.task('task3',function(){
console.log('task3 done');
});

gulp.task('end',['task1','task3','task2'],function(){
console.log('end done');
});

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

watch() 方法是用于监听文件变化,文件一修改就会执行指定的任务.

参数说明
glob需要处理的源文件匹配符路径
opts具体参看 https://github.com/shama/gaze
tasks需要执行的任务的名称数组
cb(event)每个文件变化执行的回调函数

每当监视的文件发生变化时,就会调用 cb 函数,并且会给它传入一个对象,该对象包含了文件变化的一些信息:

  • type :属性为变化的类型,可以是 added , changed , deleted
  • path :属性为发生变化的文件的路径
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
gulp.task('uglify',function(){
//do something
});
gulp.task('reload',function(){
//do something
});
gulp.watch('js/**/*.js', ['uglify','reload']);
watcher.on('change', function(event) {
console.log('File ' + event.path+ ' was ' + event.type+ ', running tasks...');
});

// same as
gulp.watch('js/**/*.js', function(event){
//变化类型 added为新增,deleted为删除,changed为改变
console.log(event.type);
//变化的文件的路径
console.log(event.path);
});

gulp.run()

run() 方法,表示要执行的任务。可能会使用单个参数的形式传递多个任务。注意:任务是尽可能多的并行执行的,并且可能不会按照指定的顺序运行.

1
2
3
gulp.task('end',function(){
gulp.run('task1','task3','task2');
});
坚持原创技术分享,您的支持将鼓励我继续创作!