gulpjs是一个前端构建东西,与gruntjs比拟,gulpjs无需写一大堆冗杂的设置参数,API也异常简朴,进修起来很轻易,而且gulpjs运用的是nodejs中stream来读取和操纵数据,其速率更快。。
1、gulp的装置
起首确保你已准确装置了nodejs环境。然后以全局体式格局装置gulp:
npm install -g gulp
全局装置gulp后,还需要在每一个要运用gulp的项目中都零丁装置一次。把目次切换到你的项目文件夹中,然后在敕令行中实行:
npm install gulp
假如想在装置的时刻把gulp写进项目package.json文件的依靠中,则能够加上–save-dev:
npm install --save-dev gulp
如许就完成了gulp的装置。至于为何在全局装置gulp后,还需要在项目中当地装置一次。
2、最先运用gulp
2.1 竖立gulpfile.js文件
就像gruntjs需要一个Gruntfile.js文件一样,gulp也需要一个文件作为它的主文件,在gulp中这个文件叫做gulpfile.js。新建一个文件名为gulpfile.js的文件,然后放到你的项目目次中。以后要做的事变就是在gulpfile.js文件中定义我们的使命了。下面是一个最简朴的gulpfile.js文件内容示例,它定义了一个默许的使命。
var gulp = require('gulp');
gulp.task('default',function(){
console.log('hello world');
});
此时我们的目次构造是如许子的:
├── gulpfile.js
├── node_modules
│ └── gulp
└── package.json
2.2 运转gulp使命
要运转gulp使命,只需切换到寄存gulpfile.js文件的目次(windows平台请运用cmd或许Power Shell等东西),然后在敕令行中实行gulp敕令就好了,gulp背面能够加上要实行的使定名,比方gulp task1,假如没有指定使定名,则会实行使定名为default的默许使命。
3、gulp的API引见
运用gulp,仅需晓得4个API即可:gulp.task(),gulp.src(),gulp.dest(),gulp.watch(),所以很轻易就可以掌握,但有几个处所需明白透辟才行,我会在下面逐一申明。为了防止涌现明白误差,发起先看一遍官方文档。
3.1 gulp.src()
在引见这个API之前我们起首来讲一下Grunt.js和Gulp.js工作体式格局的一个区分。Grunt重如果以文件为序言来运转它的工作流的,比方在Grunt中实行完一项使命后,会把效果写入到一个临时文件中,然后能够在这个临时文件内容的基本上实行别的使命,实行完成后又把效果写入到临时文件中,然后又以这个为基本继承实行别的使命…就如许重复下去。而在Gulp中,运用的是Nodejs中的stream(流),起首猎取到需要的stream,然后能够经由过程stream的pipe()要领把流导入到你想要的处所,比方Gulp的插件中,经由插件处置惩罚后的流又能够继承导入到其他插件中,固然也能够把流写入到文件中。所以Gulp是以stream为序言的,它不需要频仍的天生临时文件,这也是Gulp的速率比Grunt快的一个缘由。再回到正题上来,gulp.src()要领恰是用来猎取流的,但要注重这个流里的内容不是原始的文件流,而是一个假造文件对象流(Vinyl files),这个假造文件对象中存储着原始文件的途径、文件名、内容等信息,这个我们暂时不用去深切明白,你只需简朴的明白能够用这个要领来读取你需要操纵的文件就好了。其语法为:
gulp.src(globs[, options])
globs参数是文件婚配形式(相似正则表达式),用来婚配文件途径(包含文件名),固然这里也能够直接指定某个详细的文件途径。当有多个婚配形式时,该参数能够为一个数组。
options为可选参数。平常状况下我们不需要用到。
下面我们重点说说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'])
运用数组的体式格局另有一个优点就是能够很轻易的运用消除形式,在数组中的单个婚配形式前加上!等于消除形式,它会在婚配的效果中消除这个婚配,要注重一点的是不能在数组中的第一个元素中运用消除形式
gulp.src([*.js,'!b*.js']) //婚配一切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
3.2 gulp.dest()
gulp.dest()要领是用来写文件的,其语法为:
gulp.dest(path[,options])
path为写入文件的途径
options为一个可选的参数对象,平常我们不需要用到
要想运用好gulp.dest()这个要领,就要明白给它传入的途径参数与终究天生的文件的关联。
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.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.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.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()把文件流写入文件后,文件流依然能够继承运用。
3.3 gulp.task()
gulp.task要领用来定义使命,内部运用的是Orchestrator,其语法为:
gulp.task(name[, deps], fn)
name 为使定名
deps 是当前定义的使命需要依靠的其他使命,为一个数组。
当前定义的使命会在一切依靠的使命实行终了后才最先实行。
假如没有依靠,则可省略这个参数
fn 为使命函数,我们把使命要实行的代码都写在内里。该参数也是可选的。
gulp.task('mytask', ['array', 'of', 'task', 'names'], function() {
//定义一个有依靠的使命
// Do something
});
gulp.task()这个API没什么好讲的,但需要晓得实行多个使命时怎样来掌握使命实行的递次。
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');
});
上面的例子中我们实行two使命时,会先实行one使命,但不会去守候one使命中的异步操纵完成后再实行two使命,而是紧接着实行two使命。所以two使命会在one使命中的异步操纵完成之前就实行了。
那假如我们想守候异步使命中的异步操纵完成后再实行后续的使命,该怎样做呢?
有三种要领能够完成:
第一:在异步操纵完成后实行一个回调函数来关照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.task()就这些了,重如果要晓得当依靠是异步使命时的处置惩罚。
3.4 gulp.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); //变化的文件的途径
});
4、一些经常使用的gulp插件
gulp的插件数目虽然没有grunt那么多,但也能够说是无奇不有了,下面枚举一些经常使用的插件。
4.1 自动加载插件
运用gulp-load-plugins
装置:npm install –save-dev gulp-load-plugins
要运用gulp的插件,起首得用require来把插件加载进来,假如我们要运用的插件异常多,那我们的gulpfile.js文件开首能够就会是这个模样的:
var gulp = require('gulp'),
//一些gulp插件,abcd这些定名只是用来举个例子
a = require('gulp-a'),
b = require('gulp-b'),
c = require('gulp-c'),
d = require('gulp-d'),
e = require('gulp-e'),
f = require('gulp-f'),
g = require('gulp-g'),
//更多的插件...
z = require('gulp-z');
虽然这没什么题目,但会使我们的gulpfile.js文件变得很冗杂,看上去不那么惬意。gulp-load-plugins插件恰是用来处理这个题目。
gulp-load-plugins这个插件能自动帮你加载package.json文件里的gulp插件。比方假定你的package.json文件里的依靠是如许的:
{
"devDependencies": {
"gulp": "~3.6.0",
"gulp-rename": "~1.2.0",
"gulp-ruby-sass": "~0.4.3",
"gulp-load-plugins": "~0.5.1"
}
}
然后我们能够在gulpfile.js中运用gulp-load-plugins来帮我们加载插件:
var gulp = require('gulp');
//加载gulp-load-plugins插件,并立时运转它
var plugins = require('gulp-load-plugins')();
然后我们要运用gulp-rename和gulp-ruby-sass这两个插件的时刻,就可以够运用plugins.rename和plugins.rubySass来替代了,也就是原始插件名去掉gulp-前缀,以后再转换为驼峰定名。
实质上gulp-load-plugins是为我们做了以下的转换
plugins.rename = require('gulp-rename');
plugins.rubySass = require('gulp-ruby-sass');
gulp-load-plugins并不会一最先就加载一切package.json里的gulp插件,而是在我们需要用到某个插件的时刻,才去加载谁人插件。
末了要提示的一点是,由于gulp-load-plugins是经由过程你的package.json文件来加载插件的,所以必需要保证你需要自动加载的插件已写入到了package.json文件里,而且这些插件都是已装置好了的。
4.2 重定名
运用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
});
4.3 js文件紧缩
运用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')); //紧缩后的途径
});
4.4 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'));
});
4.5 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'));
});
4.6 js代码搜检
运用gulp-jshint
装置:npm install –save-dev gulp-jshint
用来搜检js代码
var gulp = require('gulp'),
jshint = require("gulp-jshint");
gulp.task('jsLint', function () {
gulp.src('js/*.js')
.pipe(jshint())
.pipe(jshint.reporter()); // 输出搜检效果
});
4.7 文件兼并
运用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'));
});
4.8 less和sass的编译
less运用gulp-less,装置:npm install –save-dev gulp-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运用gulp-sass,装置:npm install –save-dev gulp-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'));
});
4.9 图片紧缩
能够运用gulp-imagemin插件来紧缩jpg、png、gif等图片。
装置: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的运用比较复杂一点,而且它本身也有许多插件,发起去它的项目主页看看文档
4.10 自动革新
运用gulp-livereload插件,装置:npm install –save-dev 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']);
});