Fork me on GitHub
gulp

gulp详细入门教程

*(pattern|pattern|pattern) 匹配括号中给定的任一模式0次或多次,类似于js正则中的(pattern|pattern|pattern)*
@(pattern|pattern|pattern) 匹配括号中给定的任一模式1次,类似于js正则中的(pattern|pattern|pattern)

下面以例子来加深理解

* 能匹配 a.js,x.y,abc,abc/,但不能匹配a/b.js

*.* 能匹配 a.js,style.css,a.b,x.y

*/*/*.js 能匹配 a/b/c.js,x/y/z.js,不能匹配a/b.js,a/b/c/d.js

** 能匹配 abc,a/b.js,a/b/c.js,x/y/z,x/y/z/a.b,能用来匹配所有的目录和文件

**/*.js 能匹配 foo.js,a/foo.js,a/b/foo.js,a/b/c/foo.js

a/**/z 能匹配 a/z,a/b/z,a/b/c/z,a/d/g/h/j/k/z

a/**b/z 能匹配 a/b/z,a/sb/z,但不能匹配a/x/sb/z,因为只有单**单独出现才能匹配多级目录

?.js 能匹配 a.js,b.js,c.js

a?? 能匹配 a.b,abc,但不能匹配ab/,因为它不会匹配路径分隔符

[xyz].js 只能匹配 x.js,y.js,z.js,不会匹配xy.js,xyz.js等,整个中括号只代表一个字符

[^xyz].js 能匹配 a.js,b.js,c.js等,不能匹配x.js,y.js,z.js

     3.src:获取流

      gulp.src()方法正是用来获取流的,但要注意这个流里的内容不是原始的文件流,而是一个虚拟文件对象流(Vinyl files),这个虚拟文件对象中存储着原始文件的路径、文件名、内容等信息。其语法为:

gulp.src(globs[, options]);

      globs参数是文件匹配模式(类似正则表达式),用来匹配文件路径(包括文件名),当然这里也可以直接指定某个具体的文件路径。当有多个匹配模式时,该参数可以为一个数组;类型为String或 Array。当有多种匹配模式时可以使用数组

//使用数组的方式来匹配多种文件
gulp.src(['js/*.js','css/*.css','*.html'])

options为可选参数。以下为options的选项参数:

options.buffer

类型: Boolean 默认值: true

  如果该项被设置为 false,那么将会以 stream 方式返回 file.contents 而不是文件 buffer 的形式。这在处理一些大文件的时候将会很有用。

      注意:插件可能并不会实现对 stream 的支持。

options.read

类型: Boolean 默认值: true

如果该项被设置为 false, 那么 file.contents 会返回空值(null),也就是并不会去读取文件。

options.base

类型: String , 设置输出路径以某个路径的某个组成部分为基础向后拼接。

如, 请想像一下在一个路径为 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' 将`client/js/`替换为build
 
gulp.src('client/js/**/*.js', { base: 'client' }) // base 的值为 'client'
  .pipe(minify())
  .pipe(gulp.dest('build'));  // 写入 'build/js/somedir/somefile.js' 将`client`替换为build
复制代码

     4.dest:写文件

      gulp.dest()方法是用来写文件的,其语法为:

gulp.dest(path[,options])

path为写入文件的路径;

options为一个可选的参数对象,以下为选项参数:

options.cwd

类型: String 默认值: process.cwd()

输出目录的 cwd 参数,只在所给的输出目录是相对路径时候有效。

options.mode

类型: String 默认值: 0777

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

var gulp = require('gulp');
gulp.src('script/jquery.js')        // 获取流
    .pipe(gulp.dest('dist/foo.js')); // 写放文件

      下面再说说生成的文件路径与我们给gulp.dest()方法传入的路径参数之间的关系。  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()把文件流写入文件后,文件流仍然可以继续使用。

     5.watch:监听文件 

      gulp.watch()用来监视文件的变化,当文件发生变化后,我们可以利用它来执行相应的任务,例如文件压缩等。其语法为

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

      glob 为要监视的文件匹配模式,规则和用法与gulp.src()方法中的glob相同。 opts 为一个可选的配置对象,通常不需要用到。 tasks 为文件变化后要执行的任务,为一个数组。

复制代码
gulp.task('uglify',function(){
  //do something
});
gulp.task('reload',function(){
  //do something
});
gulp.watch('js/**/*.js', ['uglify','reload']);
复制代码

      gulp.watch()还有另外一种使用方式:

gulp.watch(glob[, opts, cb]);

glob和opts参数与第一种用法相同;

cb参数为一个函数。每当监视的文件发生变化时,就会调用这个函数,并且会给它传入一个对象,该对象包含了文件变化的一些信息,type属性为变化的类型,可以是added,changed,deleted;path属性为发生变化的文件的路径。

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

     6.task:定义任务

      gulp.task方法用来定义任务,其语法为:

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

name 为任务名;

deps 是当前定义的任务需要依赖的其他任务,为一个数组。当前定义的任务会在所有依赖的任务执行完毕后才开始执行。如果没有依赖,则可省略这个参数;

fn 为任务函数,我们把任务要执行的代码都写在里面。该参数也是可选的。

当你定义一个简单的任务时,需要传入任务名字和执行函数两个属性。

gulp.task('greet', function () {
   console.log('Hello world!');
});

      执行gulp greet的结果就是在控制台上打印出“Hello world”。

  你也可以定义一个在gulp开始运行时候默认执行的任务,并将这个任务命名为“default”:

gulp.task('default', function () {
   // Your default task
});

      前面已经介绍了gulp.task的语法,但是当有多个任务时,需要知道怎么来控制任务的执行顺序。

  可以通过任务依赖来实现。例如我想要执行one,two,three这三个任务,那我们就可以定义一个空的任务,然后把那三个任务当做这个空的任务的依赖就行了:

//只要执行default任务,就相当于把one,two,three这三个任务执行了
gulp.task('default',['one','two','three']);

      如果任务相互之间没有依赖,任务就会按你书写的顺序来执行,如果有依赖的话则会先执行依赖的任务。但是如果某个任务所依赖的任务是异步的,就要注意了,gulp并不会等待那个所依赖的异步任务完成,而是会接着执行后续的任务。例如:

复制代码
gulp.task('one',function(){
  //one是一个异步执行的任务
  setTimeout(function(){
    console.log('one is done')
  },5000);
});
 
//two任务虽然依赖于one任务,但并不会等到one任务中的异步操作完成后再执行
gulp.task('two',['one'],function(){
  console.log('two is done');
});
复制代码

      上面的例子中我们执行two任务时,会先执行one任务,但不会去等待one任务中的异步操作完成后再执行two任务,而是紧接着执行two任务。所以two任务会在one任务中的异步操作完成之前就执行了。

  那如果我们想等待异步任务中的异步操作完成后再执行后续的任务,该怎么做呢?

  有三种方法可以实现:

  第一:在异步操作完成后执行一个回调函数来通知gulp这个异步任务已经完成,这个回调函数就是任务函数的第一个参数。

复制代码
gulp.task('one', function (cb) { //cb为任务函数提供的回调,用来通知任务已经完成
    //one是一个异步执行的任务
    exec('', function (err) {
        setTimeout(function () {
            if (err) {
                return cb(err);
            }
            console.log('one is finish');
            cb();  //执行回调,表示这个异步任务已经完成
        }, 5000)
    });
});

//这时two任务会在one任务中的异步操作完成后再执行
gulp.task('two', ['one'], function () {
    console.log('two is finish');
});
复制代码

      第二:定义任务时返回一个流对象。适用于任务就是操作gulp.src获取到的流的情况。

复制代码
gulp.task('one',function(cb){
  var stream = gulp.src('client/**/*.js')
      .pipe(exec()) //exec()中有某些异步操作
      .pipe(gulp.dest('build'));
    return stream;
});
 
gulp.task('two',['one'],function(){
  console.log('two is done');
});
复制代码

      第三:返回一个promise对象,例如

复制代码
var Q = require('q');
gulp.task('one', function() {
  var deferred = Q.defer();
 
  // 执行异步的操作
  setTimeout(function() {
    deferred.resolve();
  }, 1);
  return deferred.promise;
});
 
gulp.task('two',['one'],function(){
  console.log('two is done');
});
复制代码

三、写自己的gulp任务

     1.项目需求

      我们将创建一个自己的gulp,具体的需求是通过gulp把我们自己所编写的JS文件合并压缩、CSS文件进行压缩后,并且生成新的文件。我们所需要的插件为:gulp-minify-css gulp-concat gulp-uglify gulp-rename 如下图所示,完成后的项目目录结构:

     2.安装插件

      根据我们项目的需求,安装所需要的插件,可以通过"npm install 插件名" 来安装插件

      然后打开gulpfile.js,将我们所用到的插件引用到我们项目中,代码如下:

复制代码
var gulp = require('gulp'),
    minifycss = require('gulp-minify-css'),  //CSS压缩
    concat = require('gulp-concat'),         // 文件合并
    uglify = require('gulp-uglify'),         //js压缩插件
    rename = require('gulp-rename');         // 重命名
复制代码

     3.编写任务代码

      1.压缩css

复制代码
gulp.task('minifycss', function() {
    return gulp.src('src/css/*.css')         //压缩的文件
        .pipe(minifycss())                   //执行压缩
        .pipe(gulp.dest('dist/css'));        //输出文件夹
});
复制代码

      2.JS 合并压缩

复制代码
gulp.task('minifyjs', function() {
    return gulp.src('src/js/*.js')
        .pipe(concat('all.js'))               //合并所有js到main.js
        .pipe(gulp.dest('dist/js'))           //输出main.js到文件夹
        .pipe(rename({suffix: '.min'}))       //rename压缩后的文件名
        .pipe(uglify())                       //压缩
        .pipe(gulp.dest('dist/js'));          //输出
});
复制代码

      3.将以上两个任务合并为一个任务

gulp.task('build', ['minifycss', 'minifyjs']);

      4.监视文件的变化,自动执行任务

复制代码
// 监视文件的变化,当文件有更新时执行build任务
gulp.task('watch', function () {
    gulp.watch(['src/js/*.js', 'src/css/*.css'], ['build']);
});
复制代码

      5.定义默认任务

gulp.task('default', ['build', 'watch']);

     4.执行任务

      在命令行中先转到gulp-demo目录下,就可以输入gulp命令来运行本项目了,刷新gulp-demo目录看看会出现什么结果呢。运行完成后的目录如下图:

      运行过程中的消息如下图所示:

      至此,整个gulp教程结束,同时附上gulp手册。

      手册1    手册2

 
 
标签: javascriptNodeJSgulp
posted on 2016-03-30 15:08  HackerVirus  阅读(265)  评论(0编辑  收藏  举报