1.什么是gulp
简单来说就是一个包管理工具。
2.gulp基础内容讲解
2.1 gulp.src(globs[, options])
2.1.1 说明:src方法是指定需要处理的源文件的路径,gulp借鉴了Unix操作系统的管道(pipe)思想,
前一级的输出,直接变成后一级的输入,gulp.src返回当前文件流至可用插件;
2.1.2 globs:需要处理的源文件匹配符路径。类型(必填):String or StringArray;
通配符路径匹配示例:
“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文件);
var gulp = require('gulp'),
less = require('gulp-less');
gulp.task('testLess', function () {
//gulp.src('less/test/style.less')
gulp.src(['less/**/*.less','!less/{extend,page}/*.less'])
.pipe(less())
.pipe(gulp.dest('./css'));
});
1.3 options: 类型(可选):Object,有3个属性buffer、read、base;
options.buffer: 类型:Boolean 默认:true 设置为false,将返回file.content的流并且不缓冲文件,处理大文件时非常有用;
options.read: 类型:Boolean 默认:true 设置false,将不执行读取文件操作,返回null;
options.base: 类型:String 设置输出路径以某个路径的某个组成部分为基础向后拼接,具体看下面示例
gulp.src('client/js/**/*.js')
.pipe(minify())
.pipe(gulp.dest('build')); // Writes 'build/somedir/somefile.js'
gulp.src('client/js/**/*.js', { base: 'client' })
.pipe(minify())
.pipe(gulp.dest('build')); // Writes 'build/js/somedir/somefile.js'
2. gulp.dest(path[, options])
2.1 说明:dest方法是指定处理完后文件输出的路径;
gulp.src('./client/templates/*.jade')
.pipe(jade())
.pipe(gulp.dest('./build/templates'))
.pipe(minify())
.pipe(gulp.dest('./build/minified_templates'));
2.2 path:类型(必填):String or Function 指定文件输出路径,或者定义函数返回文件输出路径亦可;
2.3 options:类型(可选):Object,有2个属性cwd、mode;
options.cwd: 类型:String 默认:process.cwd():前脚本的工作目录的路径 当文件输出路径为相对路径将会用到;
options.mode: 类型:String 默认:0777 指定被创建文件夹的权限;
3. gulp.task(name[, deps], fn)
3.1、说明:task定义一个gulp任务;
3.2、name: 类型(必填):String 指定任务的名称(不应该有空格);
3.3、deps: 类型(可选):StringArray,该任务依赖的任务(注意:被依赖的任务需要返回当前任务的事件流,请参看下面示例);
gulp.task('testLess', function () {
return gulp.src(['less/style.less'])
.pipe(less())
.pipe(gulp.dest('./css'));
});
gulp.task('minicss', ['testLess'], function () { //执行完testLess任务后再执行minicss任务
gulp.src(['css/*.css'])
.pipe(minifyCss())
.pipe(gulp.dest('./dist/css'));
});
3.4、fn: 类型(必填):Function 该任务调用的插件操作;
4、gulp.watch(glob [, opts], tasks) or gulp.watch(glob [, opts, cb])
4.1、说明:watch方法是用于监听文件变化,文件一修改就会执行指定的任务;
4.2、glob: 需要处理的源文件匹配符路径。类型(必填):String or StringArray;
4.3、opts: 类型(可选):Object 具体参看https://github.com/shama/gaze;
4.4、tasks: 类型(必填):StringArray 需要执行的任务的名称数组;
4.5、cb(event): 类型(可选):Function 每个文件变化执行的回调函数;
gulp.task('watch1', function () {
gulp.watch('less/**/*.less', ['testLess']);
});
gulp.task('watch2', function () {
gulp.watch('js/**/*.js', function (event) {
console.log('File ' + event.path + ' was ' + event.type + ', running tasks...');
});
});
3.gulp插件
3.1插件使用注意事项:
插件需要先 npm/cnpm install xx --save-dev
gulp taskname,如果 task 已经设置成 default 的依赖,直接 gulp 即可
task 中的文件路径都是相对 gulpfile.js 的
gulp.dest() 指向的目录不存在,会被创建
task 中的 gulp.src 前记得加上 return(注意我下面的示例很多并没有加)。为什么要加参考 Gulp 入门 中 「6. API 参考」src 一节
3.2 JS 压缩、合并、重命名
let gulp = require('gulp');
let concat = require('gulp-concat'); // 合并
let uglify = require('gulp-uglify'); // 压缩
let rename = require('gulp-rename'); // 重命名
let jshint = require('gulp-jshint'); // 注意需要同时安装 jshint
gulp.task('scripts', function() { // 这个任务的名称是 scripts
gulp.src('src/js/*.js') // 将 src/js/ 目录下的所有 js 文件合并
.pipe(jshint())
.pipe(jshint.reporter('default'))
.pipe(concat('all.js')) // 指定合并后的文件名为 all.js
.pipe(gulp.dest('dist/js/')) // 保存合并后的文件
.pipe(uglify()) // 压缩
// .pipe(rename('all.min.js')) // 重命名
.pipe(rename({suffix: '.min'})) // 和上一行等效
.pipe(gulp.dest('dist/js/'));
});
3.3 Sass 编译
let gulp = require('gulp');
let sass = require('gulp-sass'); // sass -> css
let prefixer = require('gulp-autoprefixer'); // 增加前缀
let minify = require('gulp-minify-css'); // css 压缩
let notify = require('gulp-notify'); // 打印提醒语句
let concat = require('gulp-concat'); // 合并
// 编译Sass
gulp.task('css', function() { // 任务名
gulp.src('sass/*.scss') // 目标 sass 文件
.pipe(sass()) // sass -> css
.pipe(prefixer('last 2 versions')) // 参数配置参考 <https://github.com/ai/browserslist>
.pipe(minify()) // 压缩
.pipe(gulp.dest('css')) // 目标目录
.pipe(notify({message: 'done'}))
.pipe(concat('all.min.css')) // 合并
.pipe(gulp.dest('css')); // 目标目录
});
3.4 图片压缩
let gulp = require('gulp');
let imagemin = require('gulp-imagemin');
let cache = require('gulp-cache'); // 减少重复压缩
gulp.task('images', function() {
gulp.src('src/images/*')
.pipe(cache(imagemin({ optimizationLevel: 3, progressive: true, interlaced: true })))
.pipe(gulp.dest('dist/images/'));
});
3.5 监控文件
gulp.task('watch', function() { // 指定任务名为 watch
// 监控 a.scss 文件,如果有修改,则执行 sass 任务
gulp.watch('src/sass/a.scss', ['sass']);
});
注意先要用 gulp watch 开启监听,或者直接将 watch 任务设置为 default 的依赖
3.6 删除文件
let gulp = require('gulp');
let clean = require('gulp-clean');
gulp.task('clean', function() {
return gulp.src(['dist/js/*', 'dist/sass/*', 'dist/images/*'], {read: false})
.pipe(clean());
});
3.7 gulp-load-plugins 模块
如果引入的插件很多,可以尝试用 gulp-load-plugins 模块,它会将 package.json 中的依赖全部引入
let gulp = require('gulp');
// let sass = require('gulp-sass');
// let minify = require('gulp-minify-css');
// let notify = require('gulp-notify');
let gulpLoadPlugins = require('gulp-load-plugins');
let plugins = gulpLoadPlugins();
// 编译Sass
gulp.task('sass', function() { // 任务名
gulp.src('src/sass/a.scss') // 目标 sass 文件
.pipe(plugins.sass({ style: 'compressed' })) // sass -> css
.pipe(plugins.minifyCss())
.pipe(plugins.notify({message: '压缩完了'}))
.pipe(gulp.dest('sass', {
cwd: 'dist', // 实际目录 dist/sass/
mode: '0644'
})); // 目标目录
});