前端開發中有一類工作特別消耗心神:合併檔案、壓縮程式碼、檢查語法、把 Sass 編譯成 CSS、監看檔案變動並自動重整瀏覽器。這些事情單獨都不難,難的是它們層出不窮、反覆發生。過去我們得為每件事找一個工具、記一套指令,既重複又耗時。
Grunt 就是為了解決這個問題而生。它是一個 JavaScript 任務運行器(task runner),依據預先定義的設定,按順序自動執行一整串任務。設定一次,之後只要一行指令就能跑完整個流程。
Grunt 建構在 Node.js 之上,因此要先安裝 Node.js,接著安裝 Grunt 的命令列介面:
npm install -g grunt-cli
grunt-cli 是命令列介面,-g 代表全域安裝。注意這裡安裝的只是「入口程式」,Grunt 本體與各項外掛仍需在專案內安裝。
Grunt 採用模組化架構,功能由外掛提供。這些外掛應該以「專案區域安裝」而非全域安裝,原因是不同專案可能需要同一外掛的不同版本。
先在專案根目錄建立 package.json,用來描述專案本身與其依賴:
{
"name": "my-project-name",
"version": "0.1.0",
"author": "Your Name",
"devDependencies": {
"grunt": "0.4.x",
"grunt-contrib-jshint": "latest",
"grunt-contrib-concat": "~0.1.1",
"grunt-contrib-uglify": "~0.1.0",
"grunt-contrib-watch": "~0.1.4"
}
}
除了專案名稱與版本,devDependencies 屬性指定了開發階段所需的模組:Grunt 核心為 0.4.x 版,jshint 取最新版,concat 不低於 0.1.1,uglify 不低於 0.1.0,watch 不低於 0.1.4。版本前綴的含義是:~ 允許修訂號變動,^ 允許 minor 版變動,latest 則永遠抓最新。
接著在專案根目錄執行:
npm install
這些模組會被安裝進 node_modules 子目錄。
若專案還沒有 package.json,可以用互動方式產生:
npm init
另一個更常用的做法是先安裝、再自動寫入設定檔。加上 --save-dev 參數,該模組就會被記進 package.json:
npm install <module> --save-dev
對應前面的設定檔,完整指令如下:
npm install grunt --save-dev npm install grunt-contrib-jshint --save-dev npm install grunt-contrib-concat --save-dev npm install grunt-contrib-uglify --save-dev npm install grunt-contrib-watch --save-dev
模組裝好後,在專案根目錄建立 Gruntfile.js。它是 Grunt 的設定檔,地位等同 package.json 之於 npm,本質上就是一個普通的 Node.js 模組:
module.exports = function (grunt) {
// 設定各模組參數,每個成員對應一個同名模組
grunt.initConfig({
jshint: {
// jshint 的參數
},
concat: {
// concat 的參數
},
uglify: {
// uglify 的參數
},
watch: {
// watch 的參數
}
});
// 從 node_modules 載入外掛
grunt.loadNpmTasks('grunt-contrib-jshint');
grunt.loadNpmTasks('grunt-contrib-concat');
grunt.loadNpmTasks('grunt-contrib-uglify');
grunt.loadNpmTasks('grunt-contrib-watch');
// 每行 registerTask 定義一個任務
grunt.registerTask('default', ['jshint', 'concat', 'uglify']);
grunt.registerTask('check', ['jshint']);
};
三個核心方法的分工:
grunt.initConfig:定義各模組的參數,每個成員對應一個同名模組。
grunt.loadNpmTasks:載入完成任務所需的模組。
grunt.registerTask:定義任務。第一個參數是任務名稱,第二個參數是陣列,表示該任務要依序使用哪些模組。default 是保留名稱,直接輸入 grunt 而不帶參數時就會執行它;範例中的 check 任務則只用 jshint 做語法檢查。
執行方式有兩種:
grunt jshint // 直接執行某個模組 grunt check // 執行某個任務,成功時顯示 "Done, without errors." grunt // 不帶參數,執行 default 任務
透過 cssmin 模組實際走一遍流程。它的作用是最小化 CSS 檔案。先安裝:
npm install grunt-contrib-cssmin --save-dev
再建立 Gruntfile.js:
module.exports = function (grunt) {
grunt.initConfig({
cssmin: {
// 目標一:壓縮
minify: {
expand: true,
cwd: 'css/',
src: ['*.css', '!*.min.css'],
dest: 'css/',
ext: '.min.css'
},
// 目標二:合併
combine: {
files: {
'css/out.min.css': ['css/part1.min.css', 'css/part2.min.css']
}
}
}
});
grunt.loadNpmTasks('grunt-contrib-cssmin');
grunt.registerTask('default', ['cssmin:minify', 'cssmin:combine']);
};
逐項解釋這裡的設定。
initConfig 的結構。它接受一個物件,成員與使用的同名模組一一對應。因為設定的是 cssmin,所以最外層有一個 cssmin 屬性。該屬性指向的物件中,除了 options 這類系統保留成員外,其餘自訂成員稱為「目標」(target)。一個模組可以有任意多個目標,範例中 cssmin 有兩個:minify 負責壓縮,combine 負責合併。
minify 目標的參數:
expand:設為 true 時,下方的萬用字元會展開成具體檔案清單。
cwd:待處理檔案所在的目錄。
src:待處理檔案,可用陣列,每項為一個檔名並支援萬用字元。
dest:輸出檔名或目錄。
ext:輸出的副檔名。
Grunt 通用參數:
filter:回傳布林值的函式,只有回傳 true 的檔案才會被處理。
dot:是否納入以點號開頭的隱藏檔。
makeBase:設為 true 時只比對路徑最後一段。例如 a?b 可匹配 /xyz/123/acb 而不匹配 /xyz/acb/123。
萬用字元規則:
*:匹配任意數量字元,不含 /。
?:匹配單一字元,不含 /。
**:匹配任意數量字元,含 /。
{}:逗號分隔的清單,表示「或」的關係。
!:置於模式開頭,表示取反,只回傳不匹配的檔案。
舉例來說,foo/*.js 匹配 foo 目錄下副檔名為 .js 的檔案;foo/**/*.js 匹配 foo 及其所有子目錄下的 .js 檔案;!*.css 匹配所有副檔名不為 .css 的檔案。萬用字元也支援前述的 {} 與 [] 語法:
{src: 'foo/th*.js'} // 等同 foo/th*.js
{src: 'foo/{a,b}*.js'} // 等同 ['foo/a*.js', 'foo/b*.js']
{src: ['foo/a*.js', 'foo/b*.js']}
combine 目標的 files 參數。它只有一個 files 屬性,格式可以是物件也可以是陣列:
// 物件寫法
files: {
'dest/b.js': ['src/bb.js', 'src/bbb.js'],
'dest/b1.js': ['src/bb1.js', 'src/bbb1.js']
}
// 陣列寫法
files: [
{ src: ['src/aa.js', 'src/aaa.js'], dest: 'dest/a.js' },
{ src: ['src/aa1.js', 'src/aaa1.js'], dest: 'dest/a1.js' }
]
若 minify 與 combine 有共同參數,可另外定義一個與兩者平行的 options:
grunt.initConfig({
cssmin: {
options: { /* 共用參數 */ },
minify: { /* ... */ },
combine: { /* ... */ }
}
});
執行時可以指定目標,用「模組名:目標名」的語法:
grunt # 先壓縮後合併 grunt cssmin:minify # 只壓縮 grunt cssmin:combine # 只合併 grunt cssmin # 只給模組名,依序執行所有目標
Grunt 的外掛生態系相當龐大。以下幾個是最常搭配使用的,命名慣例是:前綴 grunt-contrib- 者由 Grunt 團隊維護,僅 grunt- 者由社群開發。
grunt-contrib-jshint:檢查 JavaScript 語法錯誤,例如分號、括號是否遺漏。
jshint: {
options: {
eqeqeq: true, // 要求使用 === 取代 ==
trailing: true // 行尾不得有多餘空白
},
files: ['Gruntfile.js', 'lib/**/*.js']
}
grunt-contrib-concat:合併同類檔案,JavaScript 與 CSS 皆可。
concat: {
js: {
src: ['lib/module1.js', 'lib/module2.js', 'lib/plugin.js'],
dest: 'dist/script.js'
},
css: {
src: ['style/normalize.css', 'style/base.css', 'style/theme.css'],
dest: 'dist/screen.css'
}
}
grunt-contrib-uglify:壓縮 JavaScript,可同時產生 source map。
uglify: {
options: {
banner: bannerContent,
sourceMapRoot: '../',
sourceMap: 'distrib/' + name + '.min.js.map',
sourceMapUrl: name + '.min.js.map'
},
target: {
expand: true,
cwd: 'js/origin',
src: '**/*.js',
dest: 'js/'
}
}
grunt-contrib-copy:複製檔案與目錄。
// 基本寫法:把 src 複製到 dest/src
copy: {
main: {
src: 'src/*',
dest: 'dest/'
}
}
// 進階寫法:只複製檔案、不保留目錄結構
copy: {
main: {
expand: true,
cwd: 'src/',
src: '*',
dest: 'dest/',
flatten: true,
filter: 'isFile'
}
}
grunt-contrib-watch:在背景監聽檔案變動並自動觸發任務,是提升開發流暢度最有效的一個模組。
watch: {
scripts: {
files: '**/*.js',
tasks: 'jshint',
options: { livereload: true }
},
css: {
files: '**/*.sass',
tasks: ['sass'],
options: { livereload: true }
}
}
設定好後另開一個行程執行 grunt watch,此後任何 .js 檔案變動並存檔,就會自動跑 jshint;任何 .sass 變動則自動編譯。兩處都設了 livereload,任務結束後會自動重整瀏覽器(需安裝 livereload 瀏覽器外掛)。預設連接埠為 localhost:35729,也可寫成 livereload: 1337 自行指定。
其他實用模組:
// grunt-contrib-clean:刪除檔案或目錄
clean: {
build: { src: ["path/to/dir/one", "path/to/dir/two"] }
}
// grunt-autoprefixer:為 CSS 加上瀏覽器前綴
autoprefixer: {
build: {
expand: true,
cwd: 'build',
src: ['**/*.css'],
dest: 'build'
}
}
// grunt-contrib-connect:在本機啟動一個 Web Server
connect: {
server: {
options: { port: 4000, base: 'build', hostname: '*' }
}
}
// grunt-htmlhint:檢查 HTML 語法
htmlhint: {
build: {
options: {
'tag-pair': true, // 標籤是否成對
'tagname-lowercase': true, // 標籤名是否小寫
'attr-lowercase': true, // 屬性名是否小寫
'attr-value-double-quotes': true, // 屬性值是否用雙引號
'spec-char-escape': true, // 特殊字元是否轉義
'id-unique': true, // id 是否唯一
'head-script-disabled': true // head 中是否無 script
},
src: ['index.html']
}
}
// grunt-contrib-sass:Sass 轉 CSS
sass: {
build: {
options: { style: 'compressed' },
files: { 'build/css/master.css': 'assets/sass/master.scss' }
}
}
// grunt-markdown:Markdown 轉 HTML
markdown: {
all: {
files: [{ expand: true, src: '*.md', dest: 'docs/html/', ext: '.html' }],
options: { template: 'templates/index.html' }
}
}
connect 有個小技巧值得注意:它會隨著 grunt 執行結束而終止,因此實務上會把它排在 watch 之前。由於 watch 需要手動中斷,connect 也就跟著持續運行。
markdown 的 template 指定輸出模板,內容用 <%=content%> 作為佔位符:
<!DOCTYPE html> <html> <head><title>Document</title></head> <body> <div id="main" class="container"><%=content%></div> </body> </html>
值得補充的是,Grunt 屬於較早世代的前端建構工具,特色是「設定導向」——所有行為都寫在配置檔裡,學習曲線平緩但設定檔容易膨脹。後來出現的 Gulp 改採「程式碼導向」,以串流概念取代大量中間檔案;而現在主流則是 Vite、esbuild、Rollup 這類以模組打包為核心的工具。
不過 Grunt 的觀念並未過時。理解「任務定義 → 依賴宣告 → 依序執行」這套模型,再去看任何現代建構工具的設定檔,都會容易得多。若只是要處理一些簡單的檔案處理與監看需求,Grunt 至今仍然是個夠用且直覺的選擇。