Building With Gulp

===================

翻譯出處

原創翻譯，有不當的地方歡迎指出。轉載請指明出處。謝謝！

對網站資源進行優化，並使用不同瀏覽器測試並不是網站設計過程中最有意思的部分，但是這個過程中的很多重複的任務能夠使用正確的工具自動完成，從而使效率大大提高，這是讓很多開發者覺得有趣的地方。

Gulp是一個構建系統，它能通過自動執行常見任務，比如編譯預處理CSS，壓縮JavaScript和刷新瀏覽器，來改進網站開發的過程。通過本文，我們將知道如何使用Gulp來改變開發流程，從而使開發更加快速高效。

What Is Gulp?

Gulp是一個構建系統，開發者可以使用它在網站開發過程中自動執行常見任務。Gulp是基於Node.js構建的，因此Gulp源文件和你用來定義任務的Gulp文件都被寫進了JavaScript（或者CoffeeScript）裏。前端開發工程師還可以用自己熟悉的語言來編寫任務去lint JavaScript和CSS、解析模板以及在文件變動時編譯LESS文件（當然這些只是一小部分例子）。

Gulp本身雖然不能完成很多任務，但它有大量插件可用，開發者可以訪問插件頁面或者在npm搜索gulpplugin就能看到。例如，有些插件可以用來執行JSHint、編譯CoffeeScript，執行Mocha測試，甚至更新版本號。

對比其他構建工具，比如Grunt，以及最近流行的Broccoli，我相信Gulp會更勝一籌（請看後面的”Why Gulp?”部分），同時我彙總了一個使用Javascript編寫的構建工具清單，可供大家參考。

Gulp是一個可以在GitHub上找到的開源項目。

Installing Gulp

安裝Gulp的過程十分簡單。首先，需要在全局安裝Gulp包：

npm install -g gulp

然後，在項目裏面安裝Gulp：

npm install --save-dev gulp

Using Gulp

現在我們創建一個Gulp任務來壓縮JavaScript文件。首先創建一個名爲gulpfile.js的文件，這是定義Gulp任務的地方，它可以通過gulp命令來運行，接着把下面的代碼放到gulpfile.js文件裏面。

var gulp = require('gulp'),
   uglify = require('gulp-uglify');

gulp.task('minify', function () {
   gulp.src('js/app.js')
      .pipe(uglify())
      .pipe(gulp.dest('build'))
});

然後在npm裏面運行npm install -–save-dev gulp-uglify來安裝gulp-uglify，最後通過運行gulp minify來執行任務。假設js目錄下有個app.js文件，那麼一個新的app.js將被創建在編譯目錄下，它包含了js/app.js的壓縮內容。想一想，到底發生了什麼？

我們只在gulpfile.js裏做了一點事情。首先，我們加載gulp和gulp-uglify模塊：

var gulp = require('gulp'),
    uglify = require('gulp-uglify');

然後，我們定義了一個叫minify的任務，它執行時會調用函數，這個函數會作爲第二個參數：

gulp.task('minify', function () {

});

最後，也是難點所在，我們需要定義任務應該做什麼：

gulp.src('js/app.js')
   .pipe(uglify())
   .pipe(gulp.dest('build'))

如果你對數據流非常熟悉（其實大多數前端開發人員並不熟悉），上面所提供的代碼對你來說就沒有太大意義了。

STREAMS

數據流能夠通過一系列的小函數來傳遞數據，這些函數會對數據進行修改，然後把修改後的數據傳遞給下一個函數。

在上面的例子中，gulp.src()函數用字符串匹配一個文件或者文件的編號（被稱爲“glob”）,然後創建一個對象流來代表這些文件，接着傳遞給uglify()函數，它接受文件對象之後返回有新壓縮源文件的文件對象，最後那些輸出的文件被輸入gulp.dest()函數，並保存下來。

整個數據流動過程如下圖所示：

當只有一個任務的時候，函數並不會起太大的作用。然而，仔細思考下面的代碼：

gulp.task('js', function () {
   return gulp.src('js/*.js')
      .pipe(jshint())
      .pipe(jshint.reporter('default'))
      .pipe(uglify())
      .pipe(concat('app.js'))
      .pipe(gulp.dest('build'));
});

在運行這段程序之前，你需要先安裝gulp,gulp-jshint,gulp-uglify和gulp-concat。

這個任務會讓所有的文件匹配js/*.js（比如js目錄下的所有JavaScript文件），並且執行JSHint，然後打印輸出結果，取消文件縮進，最後把他們合併起來，保存爲build/app.js，整個過程如下圖所示：

如果你對Grunt 足夠熟悉，就會注意到，Gulp和Grunt的工作方式很不一樣。Grunt不使用數據流，而是使用文件，對文件執行單個任務然後保存到新的文件中，每個任務都會重複執行所有進程，文件系統頻繁的處理任務會導致Grunt的運行速度比Gulp慢。

如果想要獲取更加全面的數據流知識，請查看“Stream Handbook”.

GULP.SRC()

gulp.src()方法輸入一個glob(比如匹配一個或多個文件的字符串)或者glob數組，然後返回一個可以傳遞給插件的數據流。

Gulp使用node-glob來從你指定的glob裏面獲取文件，這裏列舉下面的例子來闡述，方便大家理解：

js/app.js 精確匹配文件
js/*.js 僅匹配js目錄下的所有後綴爲.js的文件
js/*/.js 匹配js目錄及其子目錄下所有後綴爲.js的文件
!js/app.js 從匹配結果中排除js/app.js，這種方法在你想要匹配除了特殊文件之外的所有文件時非常管用
*.+(js|css) 匹配根目錄下所有後綴爲.js或者.css的文件

此外，Gulp也有很多其他的特徵，但並不常用。如果你想了解更多的特徵，請查看Minimatch文檔。

js目錄下包含了壓縮和未壓縮的JavaScript文件，現在我們想要創建一個任務來壓縮還沒有被壓縮的文件，我們需要先匹配目錄下所有的JavaScript文件，然後排除後綴爲.min.js的文件:

gulp.src(['js/**/*.js', '!js/**/*.min.js'])

DEFINING TASKS

gulp.task()函數通常會被用來定義任務。當你定義一個簡單的任務時，需要傳入任務名字和執行函數兩個屬性。

gulp.task('greet', function () {
   console.log('Hello world!');
});

執行gulp greet的結果就是在控制檯上打印出“Hello world”.

一個任務有時也可以是一系列任務。假設要定義一個任務build來執行css、js、imgs這三個任務，我們可以通過指定一個任務數組而不是函數來完成。

gulp.task('build', ['css', 'js', 'imgs']);

這些任務不是同時進行的，所以你不能認爲在js任務開始的時候css任務已經結束了，也可能還沒有結束。爲了確保一個任務在另一個任務執行前已經結束，可以將函數和任務數組結合起來指定其依賴關係。例如，定義一個css任務，在執行前需要檢查greet任務是否已經執行完畢，這樣做就是可行的:

gulp.task('css', ['greet'], function () {
   // Deal with CSS here
});

現在，當執行css任務時，Gulp會先執行greet任務，然後在它結束後再調用你定義的函數。

DEFAULT TASKS

你可以定義一個在gulp開始運行時候默認執行的任務，並將這個任務命名爲“default”：

gulp.task('default', function () {
   // Your default task
});

PLUGINS

Gulp上有超過600種插件供你選擇，你可以在插件頁面或者npm上搜索gulpplugin來瀏覽插件列表。有些擁有“gulpfriendly”標籤的插件，他們不能算插件，但是能在Gulp上正常運行。需要注意的是，當直接在npm裏搜索時，你無法知道某一插件是否在黑名單上（你需要滾動到插件頁面底部才能看到）。

大多數插件的使用都很方便，它們都配有詳細的文檔，而且調用方法也相同（通過傳遞文件對象流給它），它們通常會對這些文件進行修改（但是有一些插件例外，比如validators），最後返回新的文件給下一個插件。

讓我們用前面的js任務來詳細說明一下：

var gulp = require('gulp'),
    jshint = require('gulp-jshint'),
    uglify = require('gulp-uglify'),
    concat = require('gulp-concat');

gulp.task('js', function () {
   return gulp.src('js/*.js')
      .pipe(jshint())
      .pipe(jshint.reporter('default'))
      .pipe(uglify())
      .pipe(concat('app.js'))
      .pipe(gulp.dest('build'));
});

這裏使用了三個插件，gulp-jshint,gulp-uglify和gulp-concat。開發者可以參考插件的README文檔，插件有很多配置選項，而且給定的初始值通常能滿足需求。細心的讀者可能會發現，程序中JSHint插件執行了2次，這是因爲第一次執行JSHint只是給文件對象附加了jshint屬性，並沒有輸出。你可以自己讀取jshint的屬性或者傳遞給默認的JSHint的接收函數或者其他的接收函數,比如jshint-stylish.

其他兩個插件的作用很清楚：uglify()函數壓縮代碼，concat(‘app.js’)函數將所有文件合併到一個叫app.js的文件中。

GULP-LOAD-PLUGINS

我發現gulp-load-plugin模塊十分有用，它能夠自動地從package.json中加載任意Gulp插件然後把它們附加到一個對象上。它的基本用法如下所示：

var gulpLoadPlugins = require('gulp-load-plugins'),
    plugins = gulpLoadPlugins();

你可以把所有代碼寫到一行，但是我並不推薦這樣做。

在執行那些代碼之後，插件對象就已經包含了插件，並使用“駝峯式”的方式進行命名（例如，gulp-ruby-sass將被加載成plugins.rubySass），這樣就可以很方便地使用了。例如，前面的js任務簡化爲如下：

var gulp = require('gulp'),
    gulpLoadPlugins = require('gulp-load-plugins'),
    plugins = gulpLoadPlugins();

gulp.task('js', function () {
   return gulp.src('js/*.js')
      .pipe(plugins.jshint())
      .pipe(plugins.jshint.reporter('default'))
      .pipe(plugins.uglify())
      .pipe(plugins.concat('app.js'))
      .pipe(gulp.dest('build'));
});

假設package.json文件如下面所示：

{
   "devDependencies": {
      "gulp-concat": "~2.2.0",
      "gulp-uglify": "~0.2.1",
      "gulp-jshint": "~1.5.1",
      "gulp": "~3.5.6"
   }
}

這個例子雖然已經夠短了，但是使用更長更復雜的Gulp文件會把它們簡化成一兩行代碼。

三月初發布的Gulp-load-plugins0.4.0版本添加了延遲加載功能，提高了插件的性能，因爲插件在使用的時候纔會被加載進來，你不用擔心package.json裏未被使用的插件影響性能（但是你需要把他們清理掉）。換句話說，如果你在執行任務時只需要兩個插件，那麼其他不相關的插件就不會被加載。

WATCHING FILES

Gulp可以監聽文件的修改動態，然後在文件被改動的時候執行一個或多個任務。這個特性十分有用（對我來說，這可能是Gulp中最有用的一個功能）。你可以保存LESS文件，接着Gulp會自動把它轉換爲CSS文件並更新瀏覽器。

使用gulp.watch()方法可以監聽文件，它接受一個glob或者glob數組（和gulp.src()一樣）以及一個任務數組來執行回調。

讓我們看看下面，build任務可以將模板轉換成html格式，然後我們希望定義一個watch任務來監聽模板文件的變化，並將這些模板轉換成html格式。watch函數的使用方法如下所示：

gulp.task('watch', function () {
   gulp.watch('templates/*.tmpl.html', ['build']);
});

現在，當改變一個模板文件時，build任務會被執行並生成HTML文件，也可以給watch函數一個回調函數，而不是一個任務數組。在這個示例中，回調函數有一個包含觸發回調函數信息的event對象：

gulp.watch('templates/*.tmpl.html', function (event) {
   console.log('Event type: ' + event.type); // added, changed, or deleted
   console.log('Event path: ' + event.path); // The path of the modified file
});

Gulp.watch()的另一個非常好的特性是返回我們熟知的watcher。利用watcher來監聽額外的事件或者向watch中添加文件。例如，在執行一系列任務和調用一個函數時，你就可以在返回的watcher中添加監聽change事件:

var watcher = gulp.watch('templates/*.tmpl.html', ['build']);
watcher.on('change', function (event) {
   console.log('Event type: ' + event.type); // added, changed, or deleted
   console.log('Event path: ' + event.path); // The path of the modified file
});

除了change事件，還可以監聽很多其他的事件:

end 在watcher結束時觸發（這意味着，在文件改變的時候，任務或者回調不會執行）
error 在出現error時觸發
ready 在文件被找到並正被監聽時觸發
nomatch 在glob沒有匹配到任何文件時觸發

Watcher對象也包含了一些可以調用的方法：

watcher.end() 停止watcher（以便停止執行後面的任務或者回調函數）
watcher.files() 返回watcher監聽的文件列表
watcher.add(glob) 將與指定glob相匹配的文件添加到watcher（也接受可選的回調當第二個參數）
watcher.remove(filepath) 從watcher中移除個別文件

Reloading Changes In The Browser

當一個文件被修改或者Gulp任務被執行時可以用Gulp來加載或者更新網頁。LiveReload和BrowserSync插件就可以用來實現在遊覽器中加載更新的內容。

LIVERELOAD

LiveReload結合了瀏覽器擴展（包括Chrome extension），在發現文件被修改時會實時更新網頁。它可以和gulp-watch插件或者前面描述的gulp-watch()函數一起使用。下面有一個gulp-livereload倉庫中的README文件提到的例子:

var gulp = require('gulp'),
    less = require('gulp-less'),
    livereload = require('gulp-livereload'),
    watch = require('gulp-watch');

gulp.task('less', function() {
   gulp.src('less/*.less')
      .pipe(watch())
      .pipe(less())
      .pipe(gulp.dest('css'))
      .pipe(livereload());
});

這會監聽到所有與less/*.less相匹配的文件的變化。一旦監測到變化，就會生成css並保存，然後重新加載網頁.

BROWSERSYNC

BroserSync在瀏覽器中展示變化的功能與LiveReload非常相似，但是它有更多的功能。

當你改變代碼的時候，BrowserSync會重新加載頁面，或者如果是css文件，會直接添加進css中，頁面並不需要再次刷新。這項功能在網站是禁止刷新的時候是很有用的。假設你正在開發單頁應用的第4頁，刷新頁面就會導致你回到開始頁。使用LiveReload的話，你就需要在每次改變代碼之後還需要點擊四次，而當你修改CSS時，插入一些變化時，BrowserSync會直接將需要修改的地方添加進CSS，就不用再點擊回退。

BrowserSync提供了一種在多個瀏覽器裏測試網頁的很好方式（查看大圖）。

BrowserSync也可以在不同瀏覽器之間同步點擊翻頁、表單操作、滾動位置。你可以在電腦和iPhone上打開不同的瀏覽器然後進行操作。所有設備上的鏈接將會隨之變化，當你向下滾動頁面時，所有設備上頁面都會向下滾動（通常還很流暢！）。當你在表單中輸入文本時，每個窗口都會有輸入。當你不想要這種行爲時，也可以把這個功能關閉。

BrowserSync不需要使用瀏覽器插件，因爲它本身就可以給你提供文件。（查看大圖）

BrowserSync不需要使用瀏覽器插件，因爲它本身就可以爲你提供文件服務（如果文件是動態的，則爲他們提供代理服務）和用來開啓瀏覽器和服務器之間的socket的腳本服務。到目前爲止這個功能的使用都十分順暢。

實際上BrowserSync對於Gulp並不算一種插件，因爲BrowserSync並不像一個插件一樣操作文件。然而，npm上的BrowserSync模塊能在Gulp上被直接調用。

首先，需要通過npm安裝一下：

npm install --save-dev browser-sync

然後gulpfile.js會啓動BrowserSync並監聽文件：

var gulp = require('gulp'),
    browserSync = require('browser-sync');

gulp.task('browser-sync', function () {
   var files = [
      'app/**/*.html',
      'app/assets/css/**/*.css',
      'app/assets/imgs/**/*.png',
      'app/assets/js/**/*.js'
   ];

   browserSync.init(files, {
      server: {
         baseDir: './app'
      }
   });
});

執行gulp browser-sync後會監聽匹配文件的變化，同時爲app目錄提供文件服務。

此外BrowserSync的開發者還寫了很多關於BrowserSync+Gulp倉庫的其他用途。

Why Gulp?

前面提到過，Gulp是爲數不多的使用JavaScript開發的構建工具之一，也有其他不是用JavaScript開發的構建工具，比如Rake，那麼我們爲什麼要選擇Gulp呢?

目前最流行的兩種使用JavaScript開發的構建工具是Grunt和Gulp。Grunt在2013年非常流行，因爲它徹底改變了許多人開發網站的方式，它有上千種插件可供用戶使用，從linting、壓縮、合併代碼到使用Bower安裝程序包,啓動Express服務都能辦到。這些和Gulp的很不一樣，Gulp只有執行單個小任務來處理文件的插件，因爲任務都是JavaScript（和Grunt使用的大型對象不同），根本不需要插件，你只需用傳統方法啓動一個Express服務就可以了。

Grunt任務擁有大量的配置，會引用大量你實際上並不需要的對象屬性，但是Gulp裏同樣的任務也許只有幾行。讓我們看個簡單的Gruntfile.js，它規定一個將LESS轉換爲CSS的任務，然後執行Autoprefixer:

grunt.initConfig({
   less: {
      development: {
         files: {
            "build/tmp/app.css": "assets/app.less"
         }
      }
   },

   autoprefixer: {
      options: {
         browsers: ['last 2 version', 'ie 8', 'ie 9']
      },
      multiple_files: {
         expand: true,
         flatten: true,
         src: 'build/tmp/app.css',
         dest: 'build/'
      }
   }
});

grunt.loadNpmTasks('grunt-contrib-less');
grunt.loadNpmTasks('grunt-autoprefixer');

grunt.registerTask('css', ['less', 'autoprefixer']);

與Gulpfile.js文件進行對比，它們執行的任務相同：

var gulp = require('gulp'),
   less = require('gulp-less'),
   autoprefix = require('gulp-autoprefixer');

gulp.task('css', function () {
   gulp.src('assets/app.less')
      .pipe(less())
      .pipe(autoprefix('last 2 version', 'ie 8', 'ie 9'))
      .pipe(gulp.dest('build'));
});

因爲Grunt比Gulp更加頻繁地操作文件系統，所以使用數據流的Gulp總是比Grunt快。對於一個小的LESS文件，gulpfile.js通常需要6ms，而gruntfile.js則需要大概50ms——慢8倍多。這只是個簡單的例子，對於長的文件，這個數字會增加得更顯著。

shhhao丶

發佈了16 篇原創文章 · 獲贊 3 · 訪問量 4萬+

私信關注

Gulp開發教程

Building With Gulp

原文地址

翻譯出處

What Is Gulp?

Installing Gulp

Using Gulp

STREAMS

GULP.SRC()

DEFINING TASKS

DEFAULT TASKS

PLUGINS

GULP-LOAD-PLUGINS

WATCHING FILES

Reloading Changes In The Browser

LIVERELOAD

BROWSERSYNC

Why Gulp?

【簡寫Mybatis-02】註冊機的實現以及SqlSession處理

手繪二維碼

.NET藉助虛擬網卡實現一個簡單異地組網工具

可視化數據大屏（完整u多功能v開發x）----- m蒙牛

自定義地圖生成geojson文件地圖選擇器

git常用命令

如何爲 Vue 項目寫單元測試

jQuery源碼剖析（一）——概覽&工具方法

Mac下配置sublime實現LaTeX

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結