gulp 常用插件的功能和用法介绍
所谓“工欲善其事,必先利其器”,一个好的构建工具能大大提升开发效率,而好的构建工具往往是由一系列插件组合而成,本篇记录一些 gulp常用插件。
gulp常用插件--文件操作
del (替代gulp-clean)
const del = require('del'); del('./dist'); // 删除整个dist文件夹
gulp-rename
描述:重命名文件。
const { src, dest } = require('gulp'); const rename = require("gulp-rename"); const renameTask = cb => { src('./hello.txt') .pipe(rename('gb/goodbye.md')) // 直接修改文件名和路径 .pipe(dest('./dist')); cb(); } const optionTask = cb => { src('./hello.txt') .pipe(rename({ dirname: "text", // 路径名 basename: "goodbye", // 主文件名 prefix: "pre-", // 前缀 suffix: "-min", // 后缀 extname: ".html" // 扩展名 })) .pipe(dest('./dist')); cb(); }
gulp-concat
描述:合并文件。
const { src, dest } = require('gulp'); const concat = require('gulp-concat'); const concatTask = cb => { src('./js/*.js') .pipe(concat('all.js')) // 合并all.js文件 .pipe(dest('./dist')); cb(); }
gulp-filter
描述:在虚拟文件流中过滤文件。
const { src, dest } = require('gulp'); const filter = require('gulp-filter'); const f = filter(['**', '!*/index.js']); const fTask = cb => { src('js/**/*.js') .pipe(f) // 过滤掉index.js这个文件 .pipe(dest('dist')); cb(); } const f1 = filter(['**', '!*/index.js'], {restore: true}); const f1Task = cb => { src('js/**/*.js') .pipe(f1) // 过滤掉index.js这个文件 .pipe(uglify()) // 对其他文件进行压缩 .pipe(f1.restore) // 返回到未过滤执行的所有文件 .pipe(dest('dist')); // 再对所有文件操作,包括index.js cb(); }
gulp常用插件--压缩
gulp-uglify
描述:压缩js文件大小。
const { src, dest } = require('gulp'); const uglify = require("gulp-uglify"); const uglifypTask = cb => { src('./hello.js') .pipe(uglify()) // 直接压缩hello.js .pipe(dest('./dist')) cb(); } const optionpTask = cb => { src('./hello.js') .pipe(uglify({ mangle: true, // 是否修改变量名,默认为 true compress: true, // 是否完全压缩,默认为 true preserveComments: 'all' // 保留所有注释 })) .pipe(dest('./dist')) cb(); }
gulp-csso
描述:压缩优化css。
const { src, dest } = require('gulp'); const csso = require('gulp-csso'); const cssopTask = cb => { src('./css/*.css') .pipe(csso()) .pipe(dest('./dist/css')) cb(); }
gulp-html-minify
描述:压缩HTML。
const { src, dest } = require('gulp'); const htmlmini = require('gulp-htmlmin'); const minpTask = cb => { src('index.html') .pipe(htmlmini()) .pipe(dest('./dist')) cb(); }
gulp-imagemin
描述:压缩图片。
const { src, dest } = require('gulp'); const imagemin = require('gulp-imagemin'); const minpTask = cb => { src('./img/*.{jpg,png,gif,ico}') .pipe(imagemin()) .pipe(dest('./dist/img')) cb(); }
gulp-zip
描述:ZIP压缩文件。
const { src, dest } = require('gulp'); const zip = require('gulp-zip'); const zipTask = cb => { src('./src/*') .pipe(zip('all.zip')) // 压缩成all.zip文件 .pipe(dest('./dist')) cb(); }
gulp常用插件--JS/CSS自动注入
gulp-autoprefixer
描述:自动为css添加浏览器前缀。
const { src, dest } = require('gulp'); const autoprefixer = require('gulp-autoprefixer'); const prefTask = cb => { src('./css/*.css') .pipe(autoprefixer()) // 直接添加前缀 .pipe(dest('dist')) cb(); } const optionTask = cb => { src('./css/*.css') .pipe(autoprefixer({ browsers: ['last 2 versions'], // 浏览器版本 cascade:true // 美化属性,默认true add: true // 是否添加前缀,默认true remove: true // 删除过时前缀,默认true flexbox: true // 为flexbox属性添加前缀,默认true })) .pipe(dest('./dist')) cb(); }
查看更多配置:options
更多浏览器版本:browsers
gulp-useref
描述:解析构建块在HTML文件来代替引用未经优化的脚本和样式表。
<!-- index.html --> <!-- build:css /css/all.css --> <link rel="stylesheet" href="css/normalize.css"> <link rel="stylesheet" href="css/main.css"> <!-- endbuild -->
// gulpfile.js const { src, dest } = require('gulp'); const useref = require('gulp-useref'); const userefTask = cb => { src('index.html') .pipe(useref()) .pipe(dest('./dist')) cb(); }
替换之后的index.html中就会变成:
<link rel="stylesheet" href="css/all.css"> // 之前的两个<link>替换成一个了
gulp-rev
描述:给静态资源文件名添加hash值:unicorn.css => unicorn-d41d8cd98f.css
const { src, dest } = require('gulp'); const rev = require('gulp-rev'); const revTask = cb => { src('./css/*.css') .pipe(rev()) .pipe(dest('./dist/css')) cb(); }
gulp-rev-replace
描述:重写被gulp-rev重命名的文件名。
const { src, dest } = require('gulp'); const rev = require('gulp-rev'); const revReplace = require('gulp-rev-replace'); const useref = require('gulp-useref'); const revReplaceTask = cb => { src('index.html') .pipe(useref()) // 替换HTML中引用的css和js .pipe(rev()) // 给css,js,html加上hash版本号 .pipe(revReplace()) // 把引用的css和js替换成有版本号的名字 .pipe(dest('./dist')) cb(); }
gulp-html-replace
描述:替换html中的构建块。
<!-- index.html --> <!-- build:css --> // css是buildName,可以自己定义 <link rel="stylesheet" href="css/normalize.css"> <link rel="stylesheet" href="css/main.css"> <!-- endbuild -->
// gulpfile.js const { src, dest } = require('gulp'); const htmlreplace = require('gulp-html-replace'); const replaceTask = cb => { src('index.html') .pipe(htmlreplace({ 'css':'all.css' // css是index.html中定义的buildName })) .pipe(dest('./dist')) cb(); }
替换之后的index.html中就会变成:
<link rel="stylesheet" href="all.css"> <!-- 之前的两个<link>替换成一个了 -->
gulp常用插件--流控制
gulp-if
描述:有条件地运行一个任务。
const { src, dest } = require('gulp'); const gulpif = require('gulp-if'); const uglify = require('gulp-uglify'); const concat = require('gulp-concat'); const condition = true; const ifTask = cb => { src('./js/*.js') .pipe(gulpif(condition, uglify(), concat('all.js'))) // condition为true时执行uglify(), else 执行concat('all.js') .pipe(dest('./dist/')); cb(); }
gulp常用插件-- 工具
gulp-load-plugins
描述:从包的依赖和附件里加载gulp插件到一个对象里给你选择。
// package.json "devDependencies": { "gulp": "^3.9.1", "gulp-concat": "^2.6.1", "gulp-rename": "^1.2.2", "gulp-uglify": "^2.0.1" } // gulpfile.js const { src, dest } = require('gulp'); const $ = require('gulp-load-plugins')(); // $ 是一个对象,加载了依赖里的插件 const minTask = cb => { src('./**/*.js') .pipe($.concat('all.js')) // 使用插件就可以用$.PluginsName() .pipe($.uglify()) .pipe($.rename('all.min.js')) .pipe(dest('./dist')) cb(); }
gulp-sass
描述:编译sass。
const { src, dest, watch } = require('gulp'); const sass = require('gulp-sass'); const sassTask = cb => { src('./sass/**/*.scss') .pipe(sass({ outputStyle: 'compressed' // 配置输出方式,默认为nested })) .pipe(dest('./dist/css')); cb(); } watch('./sass/**/*.scss', sassTask); // 实时监听sass文件变动,执行sass任务
gulp-babel
描述:将ES6代码编译成ES5。
const { src, dest } = require('gulp'); const babel = require('gulp-babel'); const jsTask = cb => { src('./js/index.js') .pipe(babel({ presets: ['@babel/env'], sourceType: 'script' })) .pipe(dest('./dist')) cb(); }