• 使用 gulp 构建一个项目
    • package.json
      • 安装依赖
    • 设计目录结构
    • 让命令行输出的文字带颜色
    • 配置 JS 任务
      • gulp-uglify
      • gulp-watch-path
      • stream-combiner2
      • gulp-sourcemaps
    • 配置 CSS 任务
      • gulp-minify-css
      • gulp-autoprefixer
    • 配置 Less 任务
    • 配置 Sass 任务
    • 配置 image 任务
    • 配置文件复制任务
    • 结语

    使用 gulp 构建一个项目

    请务必理解前面的章节后阅读此章节：

    访问论坛获取帮助

    本章将介绍

    • gulp-watch-path
    • stream-combiner2
    • gulp-sourcemaps
    • gulp-autoprefixer

    并将之前所有章节的内容组合起来编写一个前端项目所需的 gulp 代码。

    你可以在 nimojs/gulp-demo 查看完整代码。

    若你不了解npm 请务必阅读 npm模块管理器

    package.json

    如果你熟悉 npm 则可以利用 package.json 保存所有 npm install --save-dev gulp-xxx 模块依赖和模块版本。

    在命令行输入

    1. npm init

    会依次要求补全项目信息，不清楚的可以直接回车跳过

    1. name: (gulp-demo) 
    2. version: (1.0.0) 
    3. description: 
    4. entry point: (index.js) 
    5. test command: 
    6. ...
    7. ...
    8. Is this ok? (yes)

    最终会在当前目录中创建 package.json 文件并生成类似如下代码：

    1. {
    2.   "name": "gulp-demo",
    3.   "version": "0.0.0",
    4.   "description": "",
    5.   "scripts": {
    6.     "test": "echo \"Error: no test specified\" && exit 1"
    7.   },
    8.   "repository": {
    9.     "type": "git",
    10.     "url": "https://github.com/nimojs/gulp-demo.git"
    11.   },
    12.   "keywords": [
    13.     "gulp",
    14.   ],
    15.   "author": "nimojs <nimo.jser@gmail.com>",
    16.   "license": "MIT",
    17.   "bugs": {
    18.     "url": "https://github.com/nimojs/gulp-demo/issues"
    19.   },
    20.   "homepage": "https://github.com/nimojs/gulp-demo"
    21. }

    安装依赖

    安装 gulp 到项目（防止全局 gulp 升级后与此项目 gulpfile.js 代码不兼容）

    1. npm install gulp --save-dev

    此时打开 package.json 会发现多了如下代码

    1. "devDependencies": {
    2.     "gulp": "^3.8.11"
    3. }

    声明此项目的开发依赖 gulp

    接着安装其他依赖：

    安装模块较多，请耐心等待，若一直安装失败可使用npm.taobao.org

    1. npm install gulp-uglify gulp-watch-path stream-combiner2 gulp-sourcemaps gulp-minify-css gulp-autoprefixer gulp-less gulp-ruby-sass gulp-imagemin gulp-util --save-dev

    此时，package.json 将会更新

    1. "devDependencies": {
    2.     "colors": "^1.0.3",
    3.     "gulp": "^3.8.11",
    4.     "gulp-autoprefixer": "^2.1.0",
    5.     "gulp-imagemin": "^2.2.1",
    6.     "gulp-less": "^3.0.2",
    7.     "gulp-minify-css": "^1.0.0",
    8.     "gulp-ruby-sass": "^1.0.1",
    9.     "gulp-sourcemaps": "^1.5.1",
    10.     "gulp-uglify": "^1.1.0",
    11.     "gulp-watch-path": "^0.0.7",
    12.     "stream-combiner2": "^1.0.2"
    13. }

    当你将这份 gulpfile.js 配置分享给你的朋友时，就不需要将 node_modules/ 发送给他，他只需在命令行输入

    1. npm install

    就可以检测 package.json 中的 devDependencies 并安装所有依赖。

    设计目录结构

    我们将文件分为2类，一类是源码，一类是编译压缩后的版本。文件夹分别为 src 和 dist。(注意区分 dist 和 ·dest 的区别)

    1. └── src/
    2. │
    3. └── dist/

    dist/ 目录下的文件都是根据 src/ 下所有源码文件构建而成。

    在 src/ 下创建前端资源对应的的文件夹

    1. └── src/
    2.     ├── less/    *.less 文件
    3.     ├── sass/    *.scss *.sass 文件
    4.     ├── css/     *.css  文件
    5.     ├── js/      *.js 文件
    6.     ├── fonts/   字体文件
    7.     └── images/   图片
    8. └── dist/

    你可以点击 nimojs/gulp-demo 下载本章代码。

    让命令行输出的文字带颜色

    gulp 自带的输出都带时间和颜色，这样很容易识别。我们利用 gulp-util 实现同样的效果。

    1. var gulp = require('gulp')
    2. var gutil = require('gulp-util')
    4. gulp.task('default', function () {
    5.     gutil.log('message')
    6.     gutil.log(gutil.colors.red('error'))
    7.     gutil.log(gutil.colors.green('message:') + "some")
    8. })

    使用 gulp 启动默认任务以测试
    gulp-util

    配置 JS 任务

    gulp-uglify

    检测src/js/目录下的 js 文件修改后，压缩 js/ 中所有 js 文件并输出到 dist/js/ 中

    1. var uglify = require('gulp-uglify')
    3. gulp.task('uglifyjs', function () {
    4.     gulp.src('src/js/**/*.js')
    5.         .pipe(uglify())
    6.         .pipe(gulp.dest('dist/js'))
    7. })
    9. gulp.task('default', function () {
    10.     gulp.watch('src/js/**/*.js', ['uglifyjs'])
    11. })

    src/js/**/*.js 是 glob 语法。百度百科：glob模式 、node-glob

    在命令行输入 gulp 后会出现如下消息，表示已经启动。

    1. [20:39:50] Using gulpfile ~/Documents/code/gulp-book/demo/chapter7/gulpfile.js
    2. [20:39:50] Starting 'default'...
    3. [20:39:50] Finished 'default' after 13 ms

    此时编辑 src/js/log.js 文件并保存，命令行会出现如下消息，表示检测到 src/js/**/*.js 文件修改后重新编译所有 js。

    1. [20:39:52] Starting 'js'...
    2. [20:39:52] Finished 'js' after 14 ms

    gulp-watch-path

    此配置有个性能问题，当 gulp.watch 检测到 src/js/ 目录下的js文件有修改时会将所有文件全部编译。实际上我们只需要重新编译被修改的文件。

    简单介绍 gulp.watch 第二个参数为 function 时的用法。

    1. gulp.watch('src/js/**/*.js', function (event) {
    2.     console.log(event);
    3.     /*
    4.     当修改 src/js/log.js 文件时
    5.     event {
    6.         // 发生改变的类型，不管是添加，改变或是删除
    7.         type: 'changed', 
    8.         // 触发事件的文件路径
    9.         path: '/Users/nimojs/Documents/code/gulp-book/demo/chapter7/src/js/log.js'
    10.     }
    11.     */
    12. })

    我们可以利用 event 给到的信息，检测到某个 js 文件被修改时，只编写当前修改的 js 文件。

    可以利用 gulp-watch-path 配合 event 获取编译路径和输出路径。

    1. var watchPath = require('gulp-watch-path')
    3. gulp.task('watchjs', function () {
    4.     gulp.watch('src/js/**/*.js', function (event) {
    5.         var paths = watchPath(event, 'src/', 'dist/')
    6.         /*
    7.         paths
    8.             { srcPath: 'src/js/log.js',
    9.               srcDir: 'src/js/',
    10.               distPath: 'dist/js/log.js',
    11.               distDir: 'dist/js/',
    12.               srcFilename: 'log.js',
    13.               distFilename: 'log.js' }
    14.         */
    15.         gutil.log(gutil.colors.green(event.type) + ' ' + paths.srcPath)
    16.         gutil.log('Dist ' + paths.distPath)
    18.         gulp.src(paths.srcPath)
    19.             .pipe(uglify())
    20.             .pipe(gulp.dest(paths.distDir))
    21.     })
    22. })
    24. gulp.task('default', ['watchjs'])

    use-gulp-watch-path 完整代码

    watchPath(event, search, replace, distExt)

    参数 说明
    event gulp.watch 回调函数的 event
    search 需要被替换的起始字符串
    replace 第三个参数是新的的字符串
    distExt 扩展名(非必填)

    此时编辑 src/js/log.js 文件并保存，命令行会出现消息，表示检测到 src/js/log.js 文件修改后只重新编译 log.js。

    1. [21:47:25] changed src/js/log.js
    2. [21:47:25] Dist dist/js/log.js

    你可以访问 gulp-watch-path 了解更多。

    stream-combiner2

    编辑 log.js 文件时，如果文件中有 js 语法错误时，gulp 会终止运行并报错。

    当 log.js 缺少 )

    1. log('gulp-book'

    并保存文件时出现如下错误，但是错误信息不全面。而且还会让 gulp 停止运行。

    1. events.js:85
    2.       throw er; // Unhandled 'error' event
    3.             ^
    4. Error
    5.     at new JS_Parse_Error (/Users/nimojs/Documents/code/gulp-book/demo/chapter7/node_modules/gulp-uglify/node_modules/uglify-js/lib/parse.js:189:18)
    6. ...
    7. ...
    8. js_error (/Users/nimojs/Documents/code/gulp-book/demo/chapter7/node_modules/gulp-
    9. -book/demo/chapter7/node_modules/gulp-uglify/node_modules/uglify-js/lib/parse.js:1165:20)
    10.     at maybe_unary (/Users/nimojs/Documents/code/gulp-book/demo/chapter7/node_modules/gulp-uglify/node_modules/uglify-js/lib/parse.js:1328:19)

    应对这种情况，我们可以使用 Combining streams to handle errors 文档中推荐的 stream-combiner2 捕获错误信息。

    1. var handleError = function (err) {
    2.     var colors = gutil.colors;
    3.     console.log('\n')
    4.     gutil.log(colors.red('Error!'))
    5.     gutil.log('fileName: ' + colors.red(err.fileName))
    6.     gutil.log('lineNumber: ' + colors.red(err.lineNumber))
    7.     gutil.log('message: ' + err.message)
    8.     gutil.log('plugin: ' + colors.yellow(err.plugin))
    9. }
    10. var combiner = require('stream-combiner2')
    12. gulp.task('watchjs', function () {
    13.     gulp.watch('src/js/**/*.js', function (event) {
    14.         var paths = watchPath(event, 'src/', 'dist/')
    15.         /*
    16.         paths
    17.             { srcPath: 'src/js/log.js',
    18.               srcDir: 'src/js/',
    19.               distPath: 'dist/js/log.js',
    20.               distDir: 'dist/js/',
    21.               srcFilename: 'log.js',
    22.               distFilename: 'log.js' }
    23.         */
    24.         gutil.log(gutil.colors.green(event.type) + ' ' + paths.srcPath)
    25.         gutil.log('Dist ' + paths.distPath)
    27.         var combined = combiner.obj([
    28.             gulp.src(paths.srcPath),
    29.             uglify(),
    30.             gulp.dest(paths.distDir)
    31.         ])
    33.         combined.on('error', handleError)
    34.     })
    35. })

    watchjs-1 完整代码

    此时当编译错误的语法时，命令行会出现错误提示。而且不会让 gulp 停止运行。

    1. changed:src/js/log.js
    2. dist:dist/js/log.js
    3. --------------
    4. Error!
    5. fileName: /Users/nimojs/Documents/code/gulp-book/demo/chapter7/src/js/log.js
    6. lineNumber: 7
    7. message: /Users/nimojs/Documents/code/gulp-book/demo/chapter7/src/js/log.js: Unexpected token eof «undefined», expected punc «,»
    8. plugin: gulp-uglify

    gulp-sourcemaps

    JS 压缩前和压缩后比较

    1. // 压缩前
    2. var log = function (msg) {
    3.     console.log('--------');
    4.     console.log(msg)
    5.     console.log('--------');
    6. }
    7. log({a:1})
    8. log('gulp-book')
    10. // 压缩后
    11. var log=function(o){console.log("--------"),console.log(o),console.log("--------")};log({a:1}),log("gulp-book");

    压缩后的代码不存在换行符和空白符，导致出错后很难调试，好在我们可以使用 sourcemap 帮助调试

    1. var sourcemaps = require('gulp-sourcemaps')
    2. // ...
    3. var combined = combiner.obj([
    4.     gulp.src(paths.srcPath),
    5.     sourcemaps.init(),
    6.     uglify(),
    7.     sourcemaps.write('./'),
    8.     gulp.dest(paths.distDir)
    9. ])
    10. // ...

    watchjs-2 完整代码

    此时 dist/js/ 中也会生成对应的 .map 文件，以便使用 Chrome 控制台调试代码 在线文件示例：src/js/

    至此，我们完成了检测文件修改后压缩 JS 的 gulp 任务配置。

    有时我们也需要一次编译所有 js 文件。可以配置 uglifyjs 任务。

    1. gulp.task('uglifyjs', function () {
    2.     var combined = combiner.obj([
    3.         gulp.src('src/js/**/*.js'),
    4.         sourcemaps.init(),
    5.         uglify(),
    6.         sourcemaps.write('./'),
    7.         gulp.dest('dist/js/')
    8.     ])
    9.     combined.on('error', handleError)
    10. })

    在命令行输入 gulp uglifyjs 以压缩 src/js/ 下的所有 js 文件。

    配置 CSS 任务

    有时我们不想使用 LESS 或 SASS而是直接编写 CSS，但我们需要压缩 CSS 以提高页面加载速度。

    gulp-minify-css

    按照本章中压缩 JS 的方式，先编写 watchcss 任务

    1. var minifycss = require('gulp-minify-css')
    3. gulp.task('watchcss', function () {
    4.     gulp.watch('src/css/**/*.css', function (event) {
    5.         var paths = watchPath(event, 'src/', 'dist/')
    7.         gutil.log(gutil.colors.green(event.type) + ' ' + paths.srcPath)
    8.         gutil.log('Dist ' + paths.distPath)
    10.         gulp.src(paths.srcPath)
    11.             .pipe(sourcemaps.init())
    12.             .pipe(minifycss())
    13.             .pipe(sourcemaps.write('./'))
    14.             .pipe(gulp.dest(paths.distDir))
    15.     })
    16. })
    18. gulp.task('default', ['watchjs','watchcss'])

    gulp-autoprefixer

    autoprefixer 解析 CSS 文件并且添加浏览器前缀到CSS规则里。
    通过示例帮助理解

    autoprefixer 处理前：

    1. .demo {
    2.     display:flex;
    3. }

    autoprefixer 处理后：

    1. .demo {
    2.     display:-webkit-flex;
    3.     display:-ms-flexbox;
    4.     display:flex;
    5. }

    你只需要关心编写标准语法的 css，autoprefixer 会自动补全。

    在 watchcss 任务中加入 autoprefixer:

    1. gulp.task('watchcss', function () {
    2.     gulp.watch('src/css/**/*.css', function (event) {
    3.         var paths = watchPath(event, 'src/', 'dist/')
    5.         gutil.log(gutil.colors.green(event.type) + ' ' + paths.srcPath)
    6.         gutil.log('Dist ' + paths.distPath)
    8.         gulp.src(paths.srcPath)
    9.             .pipe(sourcemaps.init())
    10.             .pipe(autoprefixer({
    11.               browsers: 'last 2 versions'
    12.             }))
    13.             .pipe(minifycss())
    14.             .pipe(sourcemaps.write('./'))
    15.             .pipe(gulp.dest(paths.distDir))
    16.     })
    17. })

    更多 autoprefixer 参数请查看 gulp-autoprefixer

    有时我们也需要一次编译所有 css 文件。可以配置 minifyss 任务。

    1. gulp.task('minifycss', function () {
    2.     gulp.src('src/css/**/*.css')
    3.         .pipe(sourcemaps.init())
    4.         .pipe(autoprefixer({
    5.           browsers: 'last 2 versions'
    6.         }))
    7.         .pipe(minifycss())
    8.         .pipe(sourcemaps.write('./'))
    9.         .pipe(gulp.dest('dist/css/'))
    10. })

    在命令行输入 gulp minifyss 以压缩 src/css/ 下的所有 .css 文件并复制到 dist/css 目录下

    配置 Less 任务

    参考配置 JavaScript 任务的方式配置 less 任务

    1. var less = require('gulp-less')
    3. gulp.task('watchless', function () {
    4.     gulp.watch('src/less/**/*.less', function (event) {
    5.         var paths = watchPath(event, 'src/less/', 'dist/css/')
    7.         gutil.log(gutil.colors.green(event.type) + ' ' + paths.srcPath)
    8.         gutil.log('Dist ' + paths.distPath)
    9.         var combined = combiner.obj([
    10.             gulp.src(paths.srcPath),
    11.             sourcemaps.init(),
    12.             autoprefixer({
    13.               browsers: 'last 2 versions'
    14.             }),
    15.             less(),
    16.             minifycss(),
    17.             sourcemaps.write('./'),
    18.             gulp.dest(paths.distDir)
    19.         ])
    20.         combined.on('error', handleError)
    21.     })
    22. })
    24. gulp.task('lesscss', function () {
    25.     var combined = combiner.obj([
    26.             gulp.src('src/less/**/*.less'),
    27.             sourcemaps.init(),
    28.             autoprefixer({
    29.               browsers: 'last 2 versions'
    30.             }),
    31.             less(),
    32.             minifycss(),
    33.             sourcemaps.write('./'),
    34.             gulp.dest('dist/css/')
    35.         ])
    36.     combined.on('error', handleError)
    37. })
    39. gulp.task('default', ['watchjs', 'watchcss', 'watchless'])

    配置 Sass 任务

    参考配置 JavaScript 任务的方式配置 Sass 任务

    1. gulp.task('watchsass',function () {
    2.     gulp.watch('src/sass/**/*', function (event) {
    3.         var paths = watchPath(event, 'src/sass/', 'dist/css/')
    5.         gutil.log(gutil.colors.green(event.type) + ' ' + paths.srcPath)
    6.         gutil.log('Dist ' + paths.distPath)
    7.         sass(paths.srcPath)
    8.             .on('error', function (err) {
    9.                 console.error('Error!', err.message);
    10.             })
    11.             .pipe(sourcemaps.init())
    12.             .pipe(minifycss())
    13.             .pipe(autoprefixer({
    14.               browsers: 'last 2 versions'
    15.             }))
    16.             .pipe(sourcemaps.write('./'))
    17.             .pipe(gulp.dest(paths.distDir))
    18.     })
    19. })
    21. gulp.task('sasscss', function () {
    22.         sass('src/sass/')
    23.         .on('error', function (err) {
    24.             console.error('Error!', err.message);
    25.         })
    26.         .pipe(sourcemaps.init())
    27.         .pipe(minifycss())
    28.         .pipe(autoprefixer({
    29.           browsers: 'last 2 versions'
    30.         }))
    31.         .pipe(sourcemaps.write('./'))
    32.         .pipe(gulp.dest('dist/css'))
    33. })
    35. gulp.task('default', ['watchjs', 'watchcss', 'watchless', 'watchsass', 'watchsass'])

    配置 image 任务

    1. var imagemin = require('gulp-imagemin')
    3. gulp.task('watchimage', function () {
    4.     gulp.watch('src/images/**/*', function (event) {
    5.         var paths = watchPath(event,'src/','dist/')
    7.         gutil.log(gutil.colors.green(event.type) + ' ' + paths.srcPath)
    8.         gutil.log('Dist ' + paths.distPath)
    10.         gulp.src(paths.srcPath)
    11.             .pipe(imagemin({
    12.                 progressive: true
    13.             }))
    14.             .pipe(gulp.dest(paths.distDir))
    15.     })
    16. })
    18. gulp.task('image', function () {
    19.     gulp.src('src/images/**/*')
    20.         .pipe(imagemin({
    21.             progressive: true
    22.         }))
    23.         .pipe(gulp.dest('dist/images'))
    24. })

    配置文件复制任务

    复制 src/fonts/ 文件到 dist/ 中

    1. gulp.task('watchcopy', function () {
    2.     gulp.watch('src/fonts/**/*', function (event) {
    3.         var paths = watchPath(event)
    5.         gutil.log(gutil.colors.green(event.type) + ' ' + paths.srcPath)
    6.         gutil.log('Dist ' + paths.distPath)
    8.         gulp.src(paths.srcPath)
    9.             .pipe(gulp.dest(paths.distDir))
    10.     })
    11. })
    13. gulp.task('copy', function () {
    14.     gulp.src('src/fonts/**/*')
    15.         .pipe(gulp.dest('dist/fonts/'))
    16. })
    18. gulp.task('default', ['watchjs', 'watchcss', 'watchless', 'watchsass', 'watchimage', 'watchcopy'])

    结语

    完整代码

    访问论坛获取帮助

    你还想了解什么关于 gulp 的什么知识？ 告诉我们

    后续还会又新章节更新。你可以订阅本书 当有新章节发布时，我们会通过邮件告诉你