Gulp 使用指南

全局安装

npm install --global gulp

为项目的开发依赖（devDependencies）安装

npm install --save-dev gulp

使用

• 在项目根目录下创建一个名为 gulpfile.js 的文件

var gulp = require('gulp');



gulp.task('default', function() {

  // 将你的默认的任务代码放在这

});

• 运行构建

gulp

使用文档

http://www.gulpjs.com.cn/docs/api/

gulp的API介绍

gulp.src()

用来获取流的，但要注意这个流里的内容不是原始的文件流，而是一个虚拟文件对象流(Vinyl files)，这个虚拟文件对象中存储着原始文件的路径、文件名、内容等信息

gulp.src(globs[, options]);

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

Gulp用到的glob的匹配规则以及一些文件匹配技巧

Gulp内部使用了node-glob模块来实现其文件匹配功能

使用下面这些特殊的字符来匹配我们想要的文件

• * 匹配文件路径中的0个或多个字符，但不会匹配路径分隔符，除非路径分隔符出现在末尾

• ** 匹配路径中的0个或多个目录及其子目录,需要单独出现，即它左右不能有其他东西了。如果出现在末尾，也能匹配文件。

• ? 匹配文件路径中的一个字符(不会匹配路径分隔符)

• [...] 匹配方括号中出现的字符中的任意一个，当方括号中第一个字符为^或!时，则表示不匹配方括号中出现的其他字符中的任意一个，类似js正则表达式中的用法

• !(pattern|pattern|pattern) 匹配任何与括号中给定的任一模式都不匹配的

• ?(pattern|pattern|pattern) 匹配括号中给定的任一模式0次或1次，类似于js正则中的(pattern|pattern|pattern)?

• +(pattern|pattern|pattern) 匹配括号中给定的任一模式至少1次，类似于js正则中的(pattern|pattern|pattern)+

• *(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

多种匹配模式时可以使用数组

//使用数组的方式来匹配多种文件

gulp.src(['js/*.js','css/*.css','*.html'])

• 排除模式

使用数组的方式还有一个好处就是可以很方便的使用排除模式，在数组中的单个匹配模式前加上!即是排除模式

它会在匹配的结果中排除这个匹配，要注意一点的是不能在数组中的第一个元素中使用排除模式

// 匹配所有js文件，但排除掉以b开头的js文件

gulp.src([*.js,'!b*.js'])

// 不会排除任何文件，因为排除模式不能出现在数组的第一个元素中

gulp.src(['!b*.js',*.js])

• 展开模式

展开模式以花括号作为定界符，根据它里面的内容，会展开为多个模式，最后匹配的结果为所有展开的模式相加起来得到的结果

展开的例子

• a{b,c}d 会展开为 abd, acd

• a{b,}c 会展开为 abc, ac

• a{0..3}d 会展开为 a0d, a1d,a2d,a3d`

• a{b,c{d,e}f}g 会展开为 abg, acdfg, acefg

• a{b,c}d{e,f}g 会展开为 abdeg, acdeg, abdeg, abdfg

gulp.dest()

gulp.dest()方法是用来写文件的

gulp.dest(path[,options])

• path为写入文件的路径

• options为一个可选的参数对象，通常我们不需要用到

gulp的文件使用一般流程

• 首先通过gulp.src()方法获取到我们想要处理的文件流

• 然后把文件流通过pipe方法导入到gulp的插件中

• 最后把经过插件处理后的流再通过pipe方法导入到gulp.dest()中，gulp.dest()方法则把流中的内容写入到文件中

这里首先需要弄清楚的一点是，我们给gulp.dest()传入的路径参数，只能用来指定要生成的文件的目录，而不能指定生成文件的文件名，它生成文件的文件名使用的是导入到它的文件流自身的文件名，所以生成的文件名是由导入到它的文件流决定的，即使我们给它传入一个带有文件名的路径参数，然后它也会把这个文件名当做是目录名

var gulp = require('gulp');

gulp.src('script/jquery.js')

    .pipe(gulp.dest('dist/foo.js'));

//最终生成的文件路径为 dist/foo.js/jquery.js,而不是dist/foo.js

要想改变文件名，使用插件 gulp-rename

gulp-rename

var gulp = reruire('gulp');

//有通配符开始出现的那部分路径为 **/*.js

gulp.src('script/**/*.js')

    .pipe(gulp.dest('dist')); //最后生成的文件路径为 dist/**/*.js

//如果 **/*.js 匹配到的文件为 jquery/jquery.js ,则生成的文件路径为 dist/jquery/jquery.js

更多一点的例子

gulp.src('script/avalon/avalon.js') //没有通配符出现的情况

    .pipe(gulp.dest('dist')); //最后生成的文件路径为 dist/avalon.js



//有通配符开始出现的那部分路径为 **/underscore.js

gulp.src('script/**/underscore.js')

    //假设匹配到的文件为script/util/underscore.js

    .pipe(gulp.dest('dist')); //则最后生成的文件路径为 dist/util/underscore.js



gulp.src('script/*') //有通配符出现的那部分路径为 *

    //假设匹配到的文件为script/zepto.js

    .pipe(gulp.dest('dist')); //则最后生成的文件路径为 dist/zepto.js

通过指定gulp.src()方法配置参数中的base属性，我们可以更灵活的来改变gulp.dest()生成的文件路径
当我们没有在gulp.src()方法中配置base属性时，base的默认值为通配符开始出现之前那部分路径，例如：

gulp.src('app/src/**/*.css') //此时base的值为 app/src

给gulp.dest()传入的路径替换掉gulp.src()中的base路径，最终得到生成文件的路径

gulp.src('app/src/**/*.css') //此时base的值为app/src,也就是说它的base路径为app/src

     //设该模式匹配到了文件 app/src/css/normal.css

    .pipe(gulp.dest('dist')) //用dist替换掉base路径，最终得到 dist/css/normal.css

所以改变base路径后，gulp.dest()生成的文件路径也会改变

gulp.src(script/lib/*.js) //没有配置base参数，此时默认的base路径为script/lib

    //假设匹配到的文件为script/lib/jquery.js

    .pipe(gulp.dest('build')) //生成的文件路径为 build/jquery.js



gulp.src(script/lib/*.js, {base:'script'}) //配置了base参数，此时base路径为script

    //假设匹配到的文件为script/lib/jquery.js

    .pipe(gulp.dest('build')) //此时生成的文件路径为 build/lib/jquery.js

用gulp.dest()把文件流写入文件后，文件流仍然可以继续使用

gulp.task()

gulp.task方法用来定义任务，内部使用的是Orchestrator

语法为

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

• name 为任务名

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

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

有依赖的任务

gulp.task('mytask', ['array', 'of', 'task', 'names'], function() { 

    //定义一个有依赖的任务  // Do something

});

需要知道执行多个任务时怎么来控制任务执行的顺序

gulp中执行多个任务，可以通过任务依赖来实现

例如：我想要执行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');

});

实现等待异步任务中的异步操作完成后再执行后续的任务

三种方法可以实现

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

gulp.task('one',function(cb){ //cb为任务函数提供的回调，用来通知任务已经完成

  //one是一个异步执行的任务

  setTimeout(function(){

    console.log('one is done');

    cb();  //执行回调，表示这个异步任务已经完成

  },5000);

});



//这时two任务会在one任务中的异步操作完成后再执行

gulp.task('two',['one'],function(){

  console.log('two is done');

});

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

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');

});

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(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); //变化的文件的路径

});

常用的gulp插件

gulp-install

安装npm和bower包， 如果它们的配置文件存在的话

var install =require("gulp-install");



gulp.src(__dirname +'/templates/**')

    .pipe(gulp.dest('./'))

    .pipe(install());

gulp-clean 清空功能

var gulp =require('gulp');

var clean =require('gulp-clean');



gulp.task('clean',function(){

    return gulp.src('build',{read:false})

        .pipe(clean());

    }

);

自动加载插件 gulp-load-plugins

gulp-load-plugins

安装

npm install --save-dev gulp-load-plugins

要使用gulp的插件，首先得用require来把插件加载进来，如果我们要使用的插件非常多，那我们的gulpfile.js文件开头可能就会是这个样子的

var gulp = require('gulp'),

    //一些gulp插件,abc这些命名只是用来举个例子

    a = require('gulp-a'),

    b = require('gulp-b'),

    c = require('gulp-c'),

    //更多的插件...

    z = require('gulp-z');

gulp-load-plugins这个插件能自动帮你加载package.json文件里的gulp插件

var gulp = require('gulp');

//加载gulp-load-plugins插件，并马上运行它

var plugins = require('gulp-load-plugins')();

就可以使用plugins.rename和plugins.rubySass来代替了,也就是原始插件名去掉gulp-前缀，之后再转换为驼峰命名

plugins.rename = require('gulp-rename');

plugins.rubySass = require('gulp-ruby-sass');

因为gulp-load-plugins是通过你的package.json文件来加载插件的，所以必须要保证你需要自动加载的插件已经写入到了package.json文件里，并且这些插件都是已经安装好了的

重命名 gulp-rename

gulp-rename

安装

npm install --save-dev gulp-rename

用来重命名文件流中的文件

用gulp.dest()方法写入文件时，文件名使用的是文件流中的文件名，如果要想改变文件名，那可以在之前用gulp-rename插件来改变文件流中的文件名

var gulp = require('gulp'),

    rename = require('gulp-rename'),

    uglify = require("gulp-uglify");



gulp.task('rename', function () {

    gulp.src('js/jquery.js')

    .pipe(uglify())  //压缩

    .pipe(rename('jquery.min.js')) //会将jquery.js重命名为jquery.min.js

    .pipe(gulp.dest('js'));

    //关于gulp-rename的更多强大的用法请参考https://www.npmjs.com/package/gulp-rename

});

js文件压缩 gulp-uglify

gulp-uglify

安装

npm install --save-dev gulp-uglify

用来压缩js文件，使用的是uglify引擎

var gulp = require('gulp'),

    uglify = require("gulp-uglify");



gulp.task('minify-js', function () {

    gulp.src('js/*.js') // 要压缩的js文件

    .pipe(uglify())  //使用uglify进行压缩,更多配置请参考：

    .pipe(gulp.dest('dist/js')); //压缩后的路径

});

css文件压缩 gulp-minify-css

gulp-minify-css

安装

npm install --save-dev gulp-minify-css

要压缩css文件时可以使用该插件

var gulp = require('gulp'),

    minifyCss = require("gulp-minify-css");



gulp.task('minify-css', function () {

    gulp.src('css/*.css') // 要压缩的css文件

    .pipe(minifyCss()) //压缩css

    .pipe(gulp.dest('dist/css'));

});

html文件压缩 gulp-minify-html

gulp-minify-html

安装

npm install --save-dev gulp-minify-html

压缩html文件

var gulp = require('gulp'),

    minifyHtml = require("gulp-minify-html");



gulp.task('minify-html', function () {

    gulp.src('html/*.html') // 要压缩的html文件

    .pipe(minifyHtml()) //压缩

    .pipe(gulp.dest('dist/html'));

});

js代码检查 gulp-jshint

gulp-jshint

安装

npm install --save-dev gulp-jshint

var gulp = require('gulp'),

    jshint = require("gulp-jshint");



gulp.task('jsLint', function () {

    gulp.src('js/*.js')

    .pipe(jshint())

    .pipe(jshint.reporter()); // 输出检查结果

});

文件合并 gulp-concat

gulp-concat

安装

npm install --save-dev gulp-concat

用来把多个文件合并为一个文件,我们可以用它来合并js或css文件等，这样就能减少页面的http请求数

var gulp = require('gulp'),

    concat = require("gulp-concat");



gulp.task('concat', function () {

    gulp.src('js/*.js')  //要合并的文件

    .pipe(concat('all.js'))  // 合并匹配到的js文件并命名为 "all.js"

    .pipe(gulp.dest('dist/js'));

});

less和sass的编译

less https://www.npmjs.com/packages/gulp-less

sass https://www.npmjs.com/packages/gulp-sass

npm install --save-dev gulp-less

npm install --save-dev gulp-sass

less 编译

var gulp = require('gulp'),

    less = require("gulp-less");



gulp.task('compile-less', function () {

    gulp.src('less/*.less')

    .pipe(less())

    .pipe(gulp.dest('dist/css'));

});

sass 编译

var gulp = require('gulp'),

    sass = require("gulp-sass");



gulp.task('compile-sass', function () {

    gulp.src('sass/*.sass')

    .pipe(sass())

    .pipe(gulp.dest('dist/css'));

});

图片压缩

使用压缩jpg、png、gif等图片

https://github.com/sindresorhus/gulp-imagemin

npm install --save-dev gulp-imagemin

使用压缩

var gulp = require('gulp');

var imagemin = require('gulp-imagemin');

var pngquant = require('imagemin-pngquant'); //png图片压缩插件



gulp.task('default', function () {

    return gulp.src('src/images/*')

        .pipe(imagemin({

            progressive: true,

            use: [pngquant()] //使用pngquant来压缩png图片

        }))

        .pipe(gulp.dest('dist'));

});

gulp-imagemin的使用比较复杂一点，而且它本身也有很多插件，建议去它的项目主页看看文档

imagemin 插件 https://www.npmjs.com/browse/keyword/imageminplugin

文档 https://github.com/sindresorhus/gulp-imagemin

自动刷新

livereload插件 https://github.com/vohof/gulp-livereload

当代码变化时，它可以帮我们自动刷新页面
该插件最好配合谷歌浏览器来使用，且要安装livereload chrome extension扩展插件,不能下载的请自行FQ

使用

var gulp = require('gulp'),

    less = require('gulp-less'),

    livereload = require('gulp-livereload');



gulp.task('less', function() {

  gulp.src('less/*.less')

    .pipe(less())

    .pipe(gulp.dest('css'))

    .pipe(livereload());

});



gulp.task('watch', function() {

  livereload.listen(); //要在这里调用listen()方法

  gulp.watch('less/*.less', ['less']);

});

gulp-inject

可以注入css,javascript和web组件，不需手工更新index.html

var gulp =require('gulp');

var inject =require("gulp-inject");



gulp.task('index',function(){

    var target = gulp.src('./src/index.html');

    // It's not necessary to read the files (will speed up things), we're only after their paths:

    var sources = gulp.src(['./src/**/*.js','./src/**/*.css'],{read:false});

    return target

        .pipe(inject(sources))

        .pipe(gulp.dest('./src'));

    }

);

gulp-header

为管道中的文件增加header

var header =require('gulp-header');



gulp.src('./foo/*.js').pipe(header('Hello')).pipe(gulp.dest('./dist/')



gulp.src('./foo/*.js').pipe(header('Hello <%= name %>\n',{ name :'World'})).pipe(gulp.dest('./dist/')



gulp.src('./foo/*.js').pipe(header('Hello ${name}\n',{ name :'World'})).pipe(gulp.dest('./dist/')

//var pkg =require('./package.json');

var banner =['/**',' * <%= pkg.name %> - <%= pkg.description %>',' * @version v<%= pkg.version %>',' * @link <%= pkg.homepage %>',' * @license <%= pkg.license %>',' */',''].join('\n');



gulp.src('./foo/*.js').pipe(header(banner,{ pkg : pkg })).pipe(gulp.dest('./dist/')

相应的还有一个gulp-footer插件

gulp-filter 筛选vinyl stream中的文件

var gulp =require('gulp');

var jscs =require('gulp-jscs');

var gulpFilter =require('gulp-filter');



gulp.task('default',function(){

    // create filter instance inside task functionvar

    filter = gulpFilter(['*','!src/vendor']);

    return gulp.src('src/*.js')

    // filter a subset of the files

        .pipe(filter)

        // run them through a plugin

        .pipe(jscs())

        // bring back the previously filtered out files (optional)

        .pipe(filter.restore())

        .pipe(gulp.dest('dist'));

    }

);

gulp-changed 只允许改变的文件通过管道

var gulp =require('gulp');

var changed =require('gulp-changed');

var ngmin =require('gulp-ngmin');

// just as an examplevar SRC ='src/*.js';var DEST ='dist';



gulp.task('default',function(){

    return gulp.src(SRC)

        .pipe(changed(DEST)

        )

    // ngmin will only get the files that

    // // // changed since the last time it was run

        .pipe(ngmin())

        .pipe(gulp.dest(DEST));

    }

);

gulp-bower 执行bower安装

var gulp =require('gulp');

var bower =require('gulp-bower');



gulp.task('bower',function(){

    return bower().pipe(gulp.dest('lib/'))

    }

);

gulp-if 有条件的执行任务

gulp-replace 字符串替换插件

var replace =require('gulp-replace');



gulp.task('templates',function(){

  gulp.src(['file.txt'])

    .pipe(replace(/foo(.{3})/g,'$1foo'))

    .pipe(gulp.dest('build/file.txt'));

  }

);

gulp-shell 执行shell命令

gulp-exec 插件

gulp-ignore 忽略管道的一部分

gulp-util 工具包

gulp-wrap 将一个lodash模版包装成流内容

gulp-declare 安全的声明命名空间，设置属性

var declare = require('gulp-declare');

var concat = require('gulp-concat');



gulp.task('models',function(){

    // Define each model as a property of a namespace according to its filename

    gulp.src(['client/models/*.js'])

        .pipe(declare(

            {namespace:'MyApp.models',

            noRedeclare:true

            // Avoid duplicate declarations

            }))

        .pipe(concat('models.js'))

        // Combine into a single file

        .pipe(gulp.dest('build/js/'));

    }

);