正文

gulp介绍及常用插件使用方法(代码片段)

看不懂。。  看不懂。。  2022-10-24  375

关键词：

gulp是前端开发过程中对代码进行自动化构建的利器。它不仅能对资源进行优化，而且在开发过程中能够通过配置自动完成很多重复的任务，让我们可以专注于代码，提高工作效率。

一、API介绍

gulp常用的API只有四个：

gulp.task(),gulp.src(),gulp.dest(),gulp.watch()

1.gulp.src()

输出（Emits）符合所提供的匹配模式（glob）或者匹配模式的数组（array of globs）的文件。将返回一个Vinyl files 的 stream 它可以被 piped 到别的插件中。这个东西是用来获取流的，但要注意这个流里的内容不是原始的文件流，而是一个虚拟文件对象流(Vinyl files)，这个虚拟文件对象中存储着原始文件的路径、文件名、内容等信息。

gulp.src(globs[, options])

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

3.gulp.task()

gulp.task方法用来定义任务

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

name 为任务名
deps 是当前定义的任务需要依赖的其他任务，为一个数组。当前定义的任务会在所有依赖的任务执行完毕后才开始执行。如果没有依赖，则可省略这个参数
fn 为任务函数，我们把任务要执行的代码都写在里面。该参数也是可选的。

gulp.task(‘mytask‘, [‘array‘, ‘of‘, ‘task‘, ‘names‘], function()  //定义一个有依赖的任务
  // Do something
);

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-htmlmin 用来压缩 HTML。
gulp-imagemin 除了能压缩常见的图片格式，还能压缩 SVG。
gulp-minify-css 压缩 CSS。
gulp-uglify 压缩 Javascript。
gulp-concat 合并文件。
gulp-autoprefixer 给 CSS 增加前缀。解决某些CSS属性不是标准属性，有各种浏览器前缀的情况。
gulp-rename 修改文件名称。比如有时我们需要把app.js改成app.min.js。

del / gulp-clean 删除。俺的使用场景是：JS/CSS 文件都会在压缩后使用gulp-rev，即文件名被hash，然后再上传到 CDN，最后俺再使用 删除插件 把本地压缩后的文件删除掉，不用多余保存。
gulp-rev 把静态文件名改成hash的形式。
gulp-rev-replace 配合 gulp-rev 使用，拿到生成的 manifest.json 后替换对应的文件名称。
gulp-rev-collector 到线上环境前，我会用来配合gulp-rev使用，替换 HTML 中的路径
gulp-rev-append 给页面引用的静态文件增加hash后缀，避免被浏览器缓存...当然，如果是使用 CDN，这个套路就不行了
gulp-sourcemaps 处理 JavaScript 时生成 SourceMap；如果你不了解 SourceMap，可以看看这篇阮一峰大神的《Source Map 详解》
gulp-load-plugins 帮忙偷懒用的，可以帮我们加载插件，不用require或者import...
gulp-jshint JavaScript 代码校验
gulp-sass / gulp-less 编译sass/less文件

babel JS 语法新特性用起来。这个插件可以让我们用新的 标准/特性/提案 写 JavaScript 代码，然后再向下 转换编译，最终生成随处可用的 JavaScript代码。更通俗的说话就是：可以用新的规范写代码，经过 babel 编译后生成没有兼容问题的代码。
gulp-flatten 移动指定文件，不想压缩或者合并的时候，直接用这个插件把对应文件移动到指定文件夹。
gulp-markdown-pdf 把 Markdown 编译为 PDF
gulp-markdown 写手的福音，可以把 Markdown 转成 HTML
gulp-html2md 把 HTML 编译为 Markdown
gulp-tinypng 超屌的图片压缩工具，使用 Tinypng 引擎。
sprity 生成雪碧图。
gulp-if 可以在 pipe 里面写点逻辑。举例：比如处理 ./pub/*.js，如果文件名称是 xxx.js，那么不处理；更可以用来区分当前是开发环境还是生产环境。

三、插件使用

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文件里，并且这些插件都是已经安装好了的。

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

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

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

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()); // 输出检查结果
);

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

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的使用比较复杂一点，而且它本身也有很多插件，建议去它的项目主页看看文档

10 自动刷新

使用gulp-livereload插件，安装:npm install --save-dev gulp-livereload。
当代码变化时，它可以帮我们自动刷新页面
该插件最好配合谷歌浏览器来使用，且要安装livereload chrome extension扩展插件。

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常用插件之gulp-imagemin使用(代码片段)

更多gulp常用插件使用请访问：gulp常用插件汇总gulp-imagemin这是一款缩小PNG，JPEG，GIF和SVG图像的插件。更多使用文档请点击访问gulp-imagemin工具官网。安装一键安装不多解释npminstall--save-devgulp-imagemin使用基本的使用：constgulp=require(&... 查看详情

gulp常用插件之gulp-beautify使用(代码片段)

更多gulp常用插件使用请访问：gulp常用插件汇总gulp-beautify这是一款使用js-beautify进行资产美化插件。更多使用文档请点击访问gulp-beautify工具官网。安装一键安装不多解释npminstall--save-devgulp-beautify使用这是js-beautify的gulp插件。varbea... 查看详情

gulp常用插件之gulp-plumber使用(代码片段)

更多gulp常用插件使用请访问：gulp常用插件汇总gulp-plumber这是一款防止因gulp插件的错误而导致管道中断，plumber可以阻止gulp插件发生错误导致进程退出并输出错误日志。更多使用文档请点击访问gulp-plumber工具官网。安装npminstall--s... 查看详情

gulp常用插件之gulp-uglify使用(代码片段)

更多gulp常用插件使用请访问：gulp常用插件汇总gulp-uglify这是一款使用UglifyJS缩小js文件。更多使用文档请点击访问gulp-uglify工具官网。安装一键安装不多解释npminstall--save-devgulp-uglify使用vargulp=require('gulp');varuglify=require('gul... 查看详情

gulp常用插件之gulp-notify使用(代码片段)

更多gulp常用插件使用请访问：gulp常用插件汇总gulp-notify这是一款gulp通知插件。更多使用文档请点击访问gulp-notify工具官网。安装一键安装不多解释npminstall--save-devgulp-notify使用例1：varnotify=require("gulp-notify");gulp.src("./src... 查看详情

gulp常用插件之gulp-babel使用(代码片段)

更多gulp常用插件使用请访问：gulp常用插件汇总gulp-babel这是Babel的Gulp插件。此自述文件适用于gulp-babelv8+Babelv7检查7.x分支以了解使用Babelv6的文档更多使用文档请点击访问gulp-babel工具官网。安装安装gulp-babel，如果你想获得的下一... 查看详情

gulp常用插件之gulp-useref使用(代码片段)

更多gulp常用插件使用请访问：gulp常用插件汇总gulp-useref这是一款可以将HTML引用的多个CSS和JS合并起来，减小依赖的文件个数，从而减少浏览器发起的请求次数。gulp-useref根据注释将HTML中需要合并压缩的区块找出来，对区块内的... 查看详情

gulp常用插件之gulp-rev-collector使用(代码片段)

更多gulp常用插件使用请访问：gulp常用插件汇总gulp-rev-collector这是一款根据gulp-rev生成的manifest.json文件中的映射,去替换文件名称,也可以替换路径。更多使用文档请点击访问gulp-rev-collector工具官网。安装一键安装不多解释npminstall-... 查看详情

gulp常用插件之gulp-rev-rewrite使用(代码片段)

更多gulp常用插件使用请访问：gulp常用插件汇总gulp-rev-rewrite这是一款重写对由gulp-rev修订的资产的引用。更多使用文档请点击访问gulp-rev-rewrite工具官网。安装一键安装不多解释npminstall--save-devgulp-rev-rewrite使用最常见的使用模式包... 查看详情

gulp教程之静态资源压缩(代码片段)

...minify6.2gulp-clean-css6.3gulp-uglify6.4gulp-imagemin7总结本文简单的介绍如何压缩静态资源及使用到的对于插件，下一篇介绍使用gulp如何让文件自动添加版本号。查看详情

gulp常用插件之rev-del使用(代码片段)

更多gulp常用插件使用请访问：gulp常用插件汇总rev-del这是一款从模块（如gulp-rev）生成的修订清单中删除旧的、未使用的指纹文件。更多使用文档请点击访问rev-del工具官网。安装一键安装不多解释npminstall--save-devrev-del使用revDel(ol... 查看详情

前端构建工具gulpjs的使用介绍及技巧

...试一下gulp吧。本文导航：gulp的安装开始使用gulpgulp的API介绍一些常用的gulp插件1、gulp的安装首查看详情

前端构建工具gulpjs的使用介绍及技巧

...试一下gulp吧。本文导航：gulp的安装开始使用gulpgulp的API介绍一些常用的gulp插件1、gulp的安装首查看详情

gulp常用插件之gulp-inject使用(代码片段)

更多gulp常用插件使用请访问：gulp常用插件汇总gulp-inject这个插件的作用与wiredep类似，不同的是可以自己任意指定需要插入文件的列表。它同样是利用注释来寻找插入的位置。获取源文件流，将每个文件转换为字符串，并将每个... 查看详情

vim常用插件安装及配置方法(代码片段)

Vundle安装gitclonehttps://github.com/VundleVim/Vundle.vim.git~/.vim/bundle/Vundle.vim配置vimrc首部添加setnocompatible"beiMproved,requiredfiletypeoff"requiredsetrtp+=~/.vim/bundle/Vundle.vimcallvundle#begin()P 查看详情

gulp简介gulp基本使用步骤gulp-cli工具gulpfile.js文件gulp插件(代码片段)

Gulp介绍：gulp概念：基于node开发的前端构建工具模块，将前端机械化的操作编写成任务自动化操作，类似于webpack构建，可以完成代码压缩、语法转换、抽离公共文件、自动实现浏览器刷新等。基本使用步骤... 查看详情

pycharm使用介绍及常用配置(代码片段)

Python的IDE——PyCharm1）集成开发环境（IDE）集成开发环境（IDE，IntegratedDevelopmentEnvironment）——集成了开发软件需要的大部分工具。一般包括以下工具：图形用户界面代码编辑器（支持代码补全／... 查看详情

ansible的安装配置及常用模块介绍(代码片段)

Ansible的安装、配置及常用模块介绍 ansible安装方式1、ansible安装常用两种方式，yum安装和pip程序安装这里提供二种安装方式,任选一种即可：1、使用yum安装yuminstallepel-release-yyuminstallansible–y2、使用pip（python的包管理模块）安... 查看详情