隨著前端項目複雜度提升,手動管理多個 JS 文件的合併、壓縮、語法檢查已不可行。GruntJS 作為早期主流任務運行器,雖然現已被 Webpack/Vite/Gulp 等工具超越,但其**配置式任務編排思想**仍具參考價值,且大量存量項目仍在使用。本文從零構建 Grunt 自動化流程,涵蓋合併、壓縮、JSHint 檢查、多環境任務註冊等核心技能。
一個 HTML5 Canvas 圖表庫,包含多個模塊文件(餅圖、折線圖、散點圖等),需發布為單個壓縮文件 fishchart_v0.0.1.min.js。
下載安裝 Node.js(包含 npm)。驗證:
node -v # v18.x+
npm -v # 9.x+
npm install -g grunt-cli
# 作用:在任意目錄運行 `grunt` 命令,會查找並執行項目本地的 Grunt 實例
mkdir fishchart && cd fishchart
npm init -y # 生成 package.json
# 安裝 Grunt 核心與插件(開發依賴)
npm install grunt --save-dev
npm install grunt-contrib-concat grunt-contrib-uglify grunt-contrib-jshint --save-dev
# concat: 文件合併
# uglify: 代碼壓縮混淆
# jshint: 代碼風格/語法檢查
{
"name": "fishchart",
"version": "0.0.1",
"description": "html5 canvas chart library",
"devDependencies": {
"grunt": "~1.6.1",
"grunt-contrib-concat": "~2.1.0",
"grunt-contrib-uglify": "~5.2.0",
"grunt-contrib-jshint": "~3.2.0"
}
}
module.exports = function(grunt) {
// 1. 讀取 package.json 供模板引用
const pkg = grunt.file.readJSON('package.json');
// 2. 任務配置
grunt.initConfig({
pkg, // 使模板可用 <%= pkg.name %> 等
// 代碼檢查
jshint: {
options: {
jshintrc: '.jshintrc', // 獨立配置文件
reporter: require('jshint-stylish') // 美化輸出
},
all: ['Gruntfile.js', 'src/**/*.js', 'test/**/*.js']
},
// 文件合併
concat: {
options: {
separator: ';', // 文件間插入分號防止語法錯誤
banner: '/*! <%= pkg.name %> v<%= pkg.version %> | <%= grunt.template.today("yyyy-mm-dd") %> */\n' // 版權頭部
},
dist: {
src: ['src/**/*.js'], // 源文件匹配模式
dest: 'dist/<%= pkg.name %>_v<%= pkg.version %>.js' // 輸出文件
}
},
// 代碼壓縮
uglify: {
options: {
banner: '/*! <%= pkg.name %> v<%= pkg.version %> | <%= grunt.template.today("yyyy-mm-dd") %> */\n',
compress: {
drop_console: true, // 移除 console.*
pure_funcs: ['console.log'] // 移除純函數調用
},
mangle: {
reserved: ['$', 'jQuery', 'exports', 'define'] // 保留不混淆的標識符
}
},
dist: {
files: {
'dist/<%= pkg.name %>_v<%= pkg.version %>.min.js': ['<%= concat.dist.dest %>']
}
}
},
// 文件監聽(開發模式自動構建)
watch: {
scripts: {
files: ['src/**/*.js'],
tasks: ['development'],
options: { spawn: false }
}
}
});
// 3. 加載插件
grunt.loadNpmTasks('grunt-contrib-jshint');
grunt.loadNpmTasks('grunt-contrib-concat');
grunt.loadNpmTasks('grunt-contrib-uglify');
grunt.loadNpmTasks('grunt-contrib-watch');
// 4. 註冊任務別名
grunt.registerTask('development', ['jshint', 'concat']); // 開發構建:檢查 + 合併(不壓縮,保留可讀性)
grunt.registerTask('production', ['jshint', 'concat', 'uglify']); // 生產構建:檢查 + 合併 + 壓縮
grunt.registerTask('default', ['development']); // 默認任務
grunt.registerTask('dev', ['development', 'watch']); // 開發監聽模式
};
{
"esversion": 6,
"browser": true,
"node": true,
"globals": { "$": true, "jQuery": true, "define": true },
"asi": true, // 允許省略分號(配合項目風格)
"eqnull": true, // 允許 == null 判斷
"loopfunc": true, // 允許循環中定義函數
"unused": "vars", // 警告未使用變量
"undef": true, // 警告未聲明變量
"strict": "global" // 全局嚴格模式
}
# 開發構建(合併不壓縮,便於調試)
grunt development
# 或簡寫
grunt dev # 含 watch 監聽
# 生產構建(檢查 + 合併 + 壓縮)
grunt production
# 僅檢查代碼風格
grunt jshint
# 僅壓縮已合併文件
grunt uglify
fishchart/
├── src/
│ ├── core.js
│ ├── pie.js
│ ├── line.js
│ └── ...
├── dist/
│ ├── fishchart_v0.0.1.js # 合併未壓縮(開發調試用)
│ └── fishchart_v0.0.1.min.js # 合併並壓縮(生產發布用)
├── Gruntfile.js
├── package.json
└── .jshintrc
uglify: {
options: {
sourceMap: true,
sourceMapName: 'dist/<%= pkg.name %>_v<%= pkg.version %>.min.js.map',
sourceMapIn: 'dist/<%= pkg.name %>_v<%= pkg.version %>.js.map' // 若合併階段已生成
}
}
Grunt 本身不處理模塊格式轉換,建議配合 grunt-rollup 或 grunt-webpack 實現多格式輸出。
npm install grunt-bump --save-dev
grunt.loadNpmTasks('grunt-bump');
grunt.registerTask('release', ['bump-only', 'production', 'bump-commit']);
npm install grunt-concurrent --save-dev
grunt.registerTask('development', ['concurrent:dev']);
grunt.registerTask('production', ['concurrent:prod', 'uglify']);
// concurrent 可並行運行 jshint + concat 等獨立任務
| 維度 | Grunt | Gulp | Webpack | Vite |
|---|---|---|---|---|
| 核心模式 | 配置式(文件流) | 代碼式(流式管道) | 模塊打包器(依賴圖) | 原生 ESM + 打包器 |
| 學習曲線 | 低 | 中 | 高 | 低 |
| 增量構建 | 弱 (需 watch) | 強 (流式) | 強 (模塊級) | 極強 (無打包開發) |
| 代碼分割 | 手動配置 | 需插件 | 原生支持 | 原生支持 |
| Tree Shaking | 無 | 需插件 | 原生支持 | 原生支持 |
| 生態現狀 | 維護模式 | 維護模式 | 主流標準 | 新標準 |
build.lib)或 Webpack,配置更簡單、性能更強、生態更豐富。GruntJS 以「配置勝過代碼」的理念推動了前端工程化早期發展。通過 concat 合併、uglify 壓縮、jshint 檢查、watch 監聽、多環境任務註冊,構建了完整的自動化流水線。雖然歷史使命已基本完成,但其**任務組合、插件機制、配置模板**等設計思想深刻影響了後續構建工具。理解 Grunt 有助於看透現代工具的本質:**本質上都是「輸入 → 轉換 → 輸出」的管道編排**。