使用 gulp 構建一個項目

package.json

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

在命令行輸入

npm init

會依次要求補全項目信息，不清楚的可以直接回車跳過

name: (gulp-demo) 
version: (1.0.0) 
description: 
entry point: (index.js) 
test command: 
...
...
Is this ok? (yes)

最終會在當前目錄中創建 package.json 文件並生成類似如下代碼：

{  "name": "gulp-demo",  "version": "0.0.0",  "description": "",  "scripts": {    "test": "echo \"Error: no test specified\" && exit 1"
  },  "repository": {    "type": "git",    "url": "https://github.com/nimojs/gulp-demo.git"
  },  "keywords": [    "gulp",
  ],  "author": "nimojs <[email protected]>",  "license": "MIT",  "bugs": {    "url": "https://github.com/nimojs/gulp-demo/issues"
  },  "homepage": "https://github.com/nimojs/gulp-demo"}

安裝依賴

安裝 gulp 到項目（防止全局 gulp 升級後與此項目 gulpfile.js 代碼不兼容）

npm install gulp --save-dev

此時打開 package.json 會發現多瞭如下代碼

"devDependencies": {    "gulp": "^3.8.11"}

聲明此項目的開發依賴 gulp

接着安裝其他依賴：

安裝模塊較多，請耐心等待，若一直安裝失敗可使用npm.taobao.org

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

此時，package.json 將會更新

"devDependencies": {    "colors": "^1.0.3",    "gulp": "^3.8.11",    "gulp-autoprefixer": "^2.1.0",    "gulp-p_w_picpathmin": "^2.2.1",    "gulp-less": "^3.0.2",    "gulp-minify-css": "^1.0.0",    "gulp-ruby-sass": "^1.0.1",    "gulp-sourcemaps": "^1.5.1",    "gulp-uglify": "^1.1.0",    "gulp-watch-path": "^0.0.7",    "stream-combiner2": "^1.0.2"}

當你將這份 gulpfile.js 配置分享給你的朋友時，就不需要將 node_modules/ 發送給他，他只需在命令行輸入

npm install

就可以檢測 package.json 中的 devDependencies 並安裝所有依賴。

設計目錄結構

我們將文件分爲2類，一類是源碼，一類是編譯壓縮後的版本。文件夾分別爲 src 和 dist。(注意區分 dist 和 ·dest 的區別)

└── src/
│
└── dist/

dist/ 目錄下的文件都是根據 src/ 下所有源碼文件構建而成。

在 src/ 下創建前端資源對應的的文件夾

└── src/
	├── less/    *.less 文件
	├── sass/    *.scss *.sass 文件
	├── css/     *.css  文件
	├── js/      *.js 文件
	├── fonts/   字體文件
    └── p_w_picpaths/   圖片
└── dist/

讓命令行輸出的文字帶顏色

gulp 自帶的輸出都帶時間和顏色，這樣很容易識別。我們利用 gulp-util 實現同樣的效果。

var gulp = require('gulp')var gutil = require('gulp-util')

gulp.task('default', function () {
    gutil.log('message')
    gutil.log(gutil.colors.red('error'))
    gutil.log(gutil.colors.green('message:') + "some")
})

使用 gulp 啓動默認任務以測試 

配置 JS 任務

gulp-uglify

檢測src/js/目錄下的 js 文件修改後，壓縮 js/ 中所有 js 文件並輸出到 dist/js/ 中

var uglify = require('gulp-uglify')

gulp.task('uglifyjs', function () {
    gulp.src('src/js/**/*.js')
        .pipe(uglify())
        .pipe(gulp.dest('dist/js'))
})

gulp.task('default', function () {
    gulp.watch('src/js/**/*.js', ['uglifyjs'])
})

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

在命令行輸入 gulp 後會出現如下消息，表示已經啓動。

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

此時編輯 src/js/log.js 文件並保存，命令行會出現如下消息，表示檢測到 src/js/**/*.js 文件修改後重新編譯所有 js。

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

gulp-watch-path

此配置有個性能問題，當 gulp.watch 檢測到 src/js/ 目錄下的js文件有修改時會將所有文件全部編譯。實際上我們只需要重新編譯被修改的文件。

簡單介紹 gulp.watch 第二個參數爲 function 時的用法。

gulp.watch('src/js/**/*.js', function (event) {
    console.log(event);    /*
    當修改 src/js/log.js 文件時
    event {
        // 發生改變的類型，不管是添加，改變或是刪除
        type: 'changed', 
        // 觸發事件的文件路徑
        path: '/Users/nimojs/Documents/code/gulp-book/demo/chapter7/src/js/log.js'
    }    */})

我們可以利用 event 給到的信息，檢測到某個 js 文件被修改時，只編寫當前修改的 js 文件。

可以利用 gulp-watch-path 配合 event 獲取編譯路徑和輸出路徑。

var watchPath = require('gulp-watch-path')

gulp.task('watchjs', function () {
    gulp.watch('src/js/**/*.js', function (event) {        var paths = watchPath(event, 'src/', 'dist/')        /*
        paths
            { srcPath: 'src/js/log.js',
              srcDir: 'src/js/',
              distPath: 'dist/js/log.js',
              distDir: 'dist/js/',
              srcFilename: 'log.js',
              distFilename: 'log.js' }        */
        gutil.log(gutil.colors.green(event.type) + ' ' + paths.srcPath)
        gutil.log('Dist ' + paths.distPath)

        gulp.src(paths.srcPath)
            .pipe(uglify())
            .pipe(gulp.dest(paths.distDir))
    })
})

gulp.task('default', ['watchjs'])

watchPath(event, search, replace, distExt)

參數	說明
event	gulp.watch 回調函數的 event
search	需要被替換的起始字符串
replace	第三個參數是新的的字符串
distExt	擴展名(非必填)

此時編輯 src/js/log.js 文件並保存，命令行會出現消息，表示檢測到 src/js/log.js 文件修改後只重新編譯 log.js。

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

stream-combiner2

編輯 log.js 文件時，如果文件中有 js 語法錯誤時，gulp 會終止運行並報錯。

當 log.js 缺少 )

log('gulp-book'

並保存文件時出現如下錯誤，但是錯誤信息不全面。而且還會讓 gulp 停止運行。

events.js:85
      throw er; // Unhandled 'error' event
            ^
Error
    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)
...
...
js_error (/Users/nimojs/Documents/code/gulp-book/demo/chapter7/node_modules/gulp-
-book/demo/chapter7/node_modules/gulp-uglify/node_modules/uglify-js/lib/parse.js:1165:20)
    at maybe_unary (/Users/nimojs/Documents/code/gulp-book/demo/chapter7/node_modules/gulp-uglify/node_modules/uglify-js/lib/parse.js:1328:19)

應對這種情況，我們可以使用  stream-combiner2 捕獲錯誤信息。

var handleError = function (err) {    var colors = gutil.colors;
    console.log('\n')
    gutil.log(colors.red('Error!'))
    gutil.log('fileName: ' + colors.red(err.fileName))
    gutil.log('lineNumber: ' + colors.red(err.lineNumber))
    gutil.log('message: ' + err.message)
    gutil.log('plugin: ' + colors.yellow(err.plugin))
}var combiner = require('stream-combiner2')

gulp.task('watchjs', function () {
    gulp.watch('src/js/**/*.js', function (event) {        var paths = watchPath(event, 'src/', 'dist/')        /*
        paths
            { srcPath: 'src/js/log.js',
              srcDir: 'src/js/',
              distPath: 'dist/js/log.js',
              distDir: 'dist/js/',
              srcFilename: 'log.js',
              distFilename: 'log.js' }        */
        gutil.log(gutil.colors.green(event.type) + ' ' + paths.srcPath)
        gutil.log('Dist ' + paths.distPath)        var combined = combiner.obj([
            gulp.src(paths.srcPath),
            uglify(),
            gulp.dest(paths.distDir)
        ])

        combined.on('error', handleError)
    })
})

 

此時當編譯錯誤的語法時，命令行會出現錯誤提示。而且不會讓 gulp 停止運行。

changed:src/js/log.js
dist:dist/js/log.js
--------------
Error!
fileName: /Users/nimojs/Documents/code/gulp-book/demo/chapter7/src/js/log.js
lineNumber: 7
message: /Users/nimojs/Documents/code/gulp-book/demo/chapter7/src/js/log.js: Unexpected token eof undefined, expected punc ,
plugin: gulp-uglify

gulp-sourcemaps

JS 壓縮前和壓縮後比較

// 壓縮前var log = function (msg) {
    console.log('--------');
    console.log(msg)
    console.log('--------');
}
log({a:1})
log('gulp-book')// 壓縮後var log=function(o){console.log("--------"),console.log(o),console.log("--------")};log({a:1}),log("gulp-book");

壓縮後的代碼不存在換行符和空白符，導致出錯後很難調試，好在我們可以使用 sourcemap 幫助調試

var sourcemaps = require('gulp-sourcemaps')// ...var combined = combiner.obj([
    gulp.src(paths.srcPath),
    sourcemaps.init(),
    uglify(),
    sourcemaps.write('./'),
    gulp.dest(paths.distDir)
])// ...

 

此時 dist/js/ 中也會生成對應的 .map 文件

---

至此，我們完成了檢測文件修改後壓縮 JS 的 gulp 任務配置。

有時我們也需要一次編譯所有 js 文件。可以配置 uglifyjs 任務。

gulp.task('uglifyjs', function () {    var combined = combiner.obj([
        gulp.src('src/js/**/*.js'),
        sourcemaps.init(),
        uglify(),
        sourcemaps.write('./'),
        gulp.dest('dist/js/')
    ])
    combined.on('error', handleError)
})

在命令行輸入 gulp uglifyjs 以壓縮 src/js/ 下的所有 js 文件。

配置 CSS 任務

有時我們不想使用 LESS 或 SASS而是直接編寫 CSS，但我們需要壓縮 CSS 以提高頁面加載速度。

gulp-minify-css

按照本章中壓縮 JS 的方式，先編寫 watchcss 任務

var minifycss = require('gulp-minify-css')

gulp.task('watchcss', function () {
    gulp.watch('src/css/**/*.css', function (event) {        var paths = watchPath(event, 'src/', 'dist/')

        gutil.log(gutil.colors.green(event.type) + ' ' + paths.srcPath)
        gutil.log('Dist ' + paths.distPath)

        gulp.src(paths.srcPath)
            .pipe(sourcemaps.init())
            .pipe(minifycss())
            .pipe(sourcemaps.write('./'))
            .pipe(gulp.dest(paths.distDir))
    })
})

gulp.task('default', ['watchjs','watchcss'])

gulp-autoprefixer

autoprefixer 解析 CSS 文件並且添加瀏覽器前綴到CSS規則裏。 通過示例幫助理解

autoprefixer 處理前：

.demo {
    display:flex;
}

autoprefixer 處理後：

.demo {
    display:-webkit-flex;
    display:-ms-flexbox;
    display:flex;
}

你只需要關心編寫標準語法的 css，autoprefixer 會自動補全。

在 watchcss 任務中加入 autoprefixer:

gulp.task('watchcss', function () {
    gulp.watch('src/css/**/*.css', function (event) {        var paths = watchPath(event, 'src/', 'dist/')

        gutil.log(gutil.colors.green(event.type) + ' ' + paths.srcPath)
        gutil.log('Dist ' + paths.distPath)

        gulp.src(paths.srcPath)
            .pipe(sourcemaps.init())
            .pipe(autoprefixer({
              browsers: 'last 2 versions'
            }))
            .pipe(minifycss())
            .pipe(sourcemaps.write('./'))
            .pipe(gulp.dest(paths.distDir))
    })
})

有時我們也需要一次編譯所有 css 文件。可以配置 minifyss 任務。

gulp.task('minifycss', function () {
    gulp.src('src/css/**/*.css')
        .pipe(sourcemaps.init())
        .pipe(autoprefixer({
          browsers: 'last 2 versions'
        }))
        .pipe(minifycss())
        .pipe(sourcemaps.write('./'))
        .pipe(gulp.dest('dist/css/'))
})

在命令行輸入 gulp minifyss 以壓縮 src/css/ 下的所有 .css 文件並複製到 dist/css 目錄下

配置 Less 任務

參考配置 JavaScript 任務的方式配置 less 任務

var less = require('gulp-less')

gulp.task('watchless', function () {
    gulp.watch('src/less/**/*.less', function (event) {        var paths = watchPath(event, 'src/less/', 'dist/css/')

        gutil.log(gutil.colors.green(event.type) + ' ' + paths.srcPath)
        gutil.log('Dist ' + paths.distPath)        var combined = combiner.obj([
            gulp.src(paths.srcPath),
            sourcemaps.init(),
            autoprefixer({
              browsers: 'last 2 versions'
            }),
            less(),
            minifycss(),
            sourcemaps.write('./'),
            gulp.dest(paths.distDir)
        ])
        combined.on('error', handleError)
    })
})

gulp.task('lesscss', function () {    var combined = combiner.obj([
            gulp.src('src/less/**/*.less'),
            sourcemaps.init(),
            autoprefixer({
              browsers: 'last 2 versions'
            }),
            less(),
            minifycss(),
            sourcemaps.write('./'),
            gulp.dest('dist/css/')
        ])
    combined.on('error', handleError)
})

gulp.task('default', ['watchjs', 'watchcss', 'watchless'])

配置 Sass 任務

參考配置 JavaScript 任務的方式配置 Sass 任務

gulp.task('watchsass',function () {
    gulp.watch('src/sass/**/*', function (event) {        var paths = watchPath(event, 'src/sass/', 'dist/css/')

        gutil.log(gutil.colors.green(event.type) + ' ' + paths.srcPath)
        gutil.log('Dist ' + paths.distPath)
        sass(paths.srcPath)
            .on('error', function (err) {
                console.error('Error!', err.message);
            })
            .pipe(sourcemaps.init())
            .pipe(minifycss())
            .pipe(autoprefixer({
              browsers: 'last 2 versions'
            }))
            .pipe(sourcemaps.write('./'))
            .pipe(gulp.dest(paths.distDir))
    })
})

gulp.task('sasscss', function () {
        sass('src/sass/')
        .on('error', function (err) {
            console.error('Error!', err.message);
        })
        .pipe(sourcemaps.init())
        .pipe(minifycss())
        .pipe(autoprefixer({
          browsers: 'last 2 versions'
        }))
        .pipe(sourcemaps.write('./'))
        .pipe(gulp.dest('dist/css'))
})

gulp.task('default', ['watchjs', 'watchcss', 'watchless', 'watchsass', 'watchsass'])

配置 p_w_picpath 任務

var p_w_picpathmin = require('gulp-p_w_picpathmin')

gulp.task('watchp_w_picpath', function () {
    gulp.watch('src/p_w_picpaths/**/*', function (event) {        var paths = watchPath(event,'src/','dist/')

        gutil.log(gutil.colors.green(event.type) + ' ' + paths.srcPath)
        gutil.log('Dist ' + paths.distPath)

        gulp.src(paths.srcPath)
            .pipe(p_w_picpathmin({
                progressive: true
            }))
            .pipe(gulp.dest(paths.distDir))
    })
})

gulp.task('p_w_picpath', function () {
    gulp.src('src/p_w_picpaths/**/*')
        .pipe(p_w_picpathmin({
            progressive: true
        }))
        .pipe(gulp.dest('dist/p_w_picpaths'))
})

配置文件複製任務

複製 src/fonts/ 文件到 dist/ 中

gulp.task('watchcopy', function () {
    gulp.watch('src/fonts/**/*', function (event) {        var paths = watchPath(event)

        gutil.log(gutil.colors.green(event.type) + ' ' + paths.srcPath)
        gutil.log('Dist ' + paths.distPath)

        gulp.src(paths.srcPath)
            .pipe(gulp.dest(paths.distDir))
    })
})

gulp.task('copy', function () {
    gulp.src('src/fonts/**/*')
        .pipe(gulp.dest('dist/fonts/'))
})

gulp.task('default', ['watchjs', 'watchcss', 'watchless', 'watchsass', 'watchp_w_picpath', 'watchcopy'])