gulp安装:用cnpm的时候把npm换成cnpm就好了。
npm install -g gulp(全局安装,安装一次就好)
npm install --save-dev gulp(安装到项目目录下,在每次的项目下安装)
gulp的安装过程:
首先全局安装:npm install -g gulp(全局安装,安装一次就好)
1:在项目文件下初始化:npm init,用户需要回答一些问题,然后再当前目录生成一个基本的package.json文件,所有问题之中只有项目名称(name)和项目版本是必填,其它的是选填。(项目需要依赖那些插件都是在package.json中显示,方便项目转移)
2:给当前的目录配置gulp环境:npm install gulp --save-dev
gulp常用插件安装:(编译、压缩、合并、代码的语法检查、即时刷新)(一次性安装常用插件):
npm install gulp-concat gulp-uglify gulp-rename gulp-jshint-html-reporter gulp-imagemin --save-dev
gulp-concat :合并
gulp-uglify:压缩
gulp-rename:重命名
gulp-jshint-html-reporter:输出代码的检测报告
gulp-imagemin:图片压缩
单个安装:npm install gulp-concat --save-dev
卸载gulp:npm uninstall gulp --save-dev
gulp的基本用法:
在项目根目录下新建一个js文件并命名为 gulpfile.js ,把下面的代码粘贴进去:
例如:
然后再运行watchsass这个任务就好了。
gulpfile.js
// 引入 gulp
var gulp = require('gulp'); // 引入安装的插件 var jshint = require('gulp-jshint'); var sass = require('gulp-sass'); var concat = require('gulp-concat'); var uglify = require('gulp-uglify'); var rename = require('gulp-rename'); // 检查脚本 gulp.task('lint', function() {//定义一个任务,lint gulp.src('./js/*.js')//编译目标文件 .pipe(jshint()) .pipe(jshint.reporter('default')); }); // 编译Sass输出为css文件 gulp.task('sass', function() { gulp.src('./scss/*.scss') .pipe(sass()) .pipe(gulp.dest('./css')); }); // 合并,压缩文件 gulp.task('scripts', function() { gulp.src('./js/*.js') .pipe(concat('all.js')) .pipe(gulp.dest('./dist')) .pipe(rename('all.min.js')) .pipe(uglify()) .pipe(gulp.dest('./dist')); }); // 默认任务 gulp.task('default', function(){ gulp.run('lint', 'sass', 'scripts'); // 监听文件变化 gulp.watch('./js/*.js', function(){ gulp.run('lint', 'sass', 'scripts'); }); });
现在,分段解释下这段代码。
引入组件
var gulp = require('gulp'); var jshint = require('gulp-jshint'); var sass = require('gulp-sass'); var concat = require('gulp-concat'); var uglify = require('gulp-uglify'); var rename = require('gulp-rename');
这一步,我们引入了核心的gulp和其他依赖组件,接下来,分开创建lint, sass, scripts 和 default这四个不同的任务。
Lint任务
gulp.task('lint', function() {gulp.src('./js/*.js') .pipe(jshint()) .pipe(jshint.reporter('default')); });
Link任务会检查 js/
目录下得js文件有没有报错或警告。
Sass任务
gulp.task('sass', function() {gulp.src('./scss/*.scss') .pipe(sass()) .pipe(gulp.dest('./css')); });
Sass任务会编译 scss/
目录下的scss文件,并把编译完成的css文件保存到 /css
目录中。
Scripts 任务
gulp.task('scripts', function() {gulp.src('./js/*.js') .pipe(concat('all.js')) .pipe(gulp.dest('./dist')) .pipe(rename('all.min.js')) .pipe(uglify()) .pipe(gulp.dest('./dist')); });
scripts任务会合并 js/
目录下得所有得js文件并输出到 dist/
目录,然后gulp会重命名、压缩合并的文件,也输出到 dist/
目录。
default任务
gulp.task('default', function(){gulp.run('lint', 'sass', 'scripts'); gulp.watch('./js/*.js', function(){ gulp.run('lint', 'sass', 'scripts'); }); });
这时,我们创建了一个基于其他任务的default任务。使用 .run()
方法关联和运行我们上面定义的任务,使用 .watch()
方法去监听指定目录的文件变化,当有文件变化时,会运行回调定义的其他任务。
现在,回到命令行,可以直接运行gulp任务了。
gulp
这将执行定义的default任务,换言之,这和以下的命令式同一个意思
gulp default
当然,我们可以运行在gulpfile.js中定义的任意任务,比如,现在运行sass任务:
gulp sass
安装相关插件
8.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'), //更多的插件... 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文件里,并且这些插件都是已经安装好了的。
8.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 });
8.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')); //压缩后的路径 });
8.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')); });
8.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')); });
8.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()); // 输出检查结果 });
8.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')); });
8.8 less和sass的编译(gulp-less,gulp-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')); });
8.9 图片压缩(gulp-imagemin)
可以使用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的使用比较复杂一点,而且它本身也有很多插件,建议去它的项目主页看看文档
8.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']); });
9. Gulpfile.js
/*** 组件安装* npm install gulp-util gulp-imagemin gulp-ruby-sass gulp-minify-css gulp-minify-html gulp-load-plugins gulp-jshint gulp-uglify gulp-rename gulp-concat gulp-clean --save-dev* imagemin 图片压缩* rubySass sass压缩* minifyCss css压缩* jshint js检查* uglify js压缩* minifyHtml html压缩* rename 文件重命名* concat 文件合并* clean 清空文件夹* gulp-load-plugins 自动加载*/var gulp = require('gulp');//加载gulp-load-plugins插件,并马上运行它 var plugins = require('gulp-load-plugins')(); //默认的任务 /*gulp.task('default',function(){ //进行文件监控,文件变动触发执行任务 gulp.watch('staticDev/css/!*.css', ['pcCss']); gulp.watch('staticDev/demo/css/!*.css', ['telCss']); gulp.watch('staticDev/js/!*.js', ['pcJs']); gulp.watch('staticDev/demo/js/!*.js', ['telJs']); gulp.watch('staticDev/images/!*', ['pcImg']); gulp.watch('staticDev/demo/images/!*', ['telImg']); });*/ gulp.task('default',['css','js','img']); //css压缩 gulp.task('css', function () { var cssSrc = ['staticDev/css/*.css','!staticDev/css/*.min.css'], cssDst = './static-dev/css/'; gulp.src(cssSrc) //要压缩的文件 .pipe(plugins.minifyCss()) //压缩 .pipe(gulp.dest(cssDst)); //压缩后的文件路径 var cssDemoSrc = ['staticDev/demo/css/*.css','!staticDev/demo/css/*.min.css'], cssDemoDst = './static-dev/demo/css/'; gulp.src(cssDemoSrc) //要压缩的文件 .pipe(plugins.concat('main.css'))//合并文件,文件名为main.css .pipe(plugins.minifyCss()) //压缩 .pipe(plugins.rename({ suffix: '.min' })) //改字,加上min标志 .pipe(gulp.dest(cssDemoDst)); //压缩后的文件路径 }); //JS压缩 gulp.task('js', function () { var jsSrc = ['staticDev/js/*.js','!staticDev/js/*.min.js'], jsDst = 'static-dev/js/'; gulp.src(jsSrc) .pipe(plugins.uglify()) .pipe(gulp.dest(jsDst)); var jsDemoSrc = ['staticDev/demo/js/*.js','!staticDev/demo/js/*.min.js'], jsDemoDst = 'static-dev/demo/js/'; gulp.src(jsDemoSrc) .pipe(plugins.concat('main.jf')) .pipe(plugins.uglify()) .pipe(plugins.rename({ suffix: '.min' })) .pipe(gulp.dest(jsDemoDst)); }); //img压缩 gulp.task('img', function () { var imgSrc = 'staticDev/images/*', imgDst = 'static-dev/images/'; gulp.src(imgSrc) .pipe(plugins.imagemin()) .pipe(gulp.dest(imgDst)); var imgDemoSrc = 'staticDev/demo/images/*', imgDemoDst = 'static-dev/demo/images/'; gulp.src(imgDemoSrc) .pipe(plugins.imagemin()) .pipe(gulp.dest(imgDemoDst)); });