GruntJS构建Web程序
更新日期:
GruntJS构建Web程序
Gruntjs是JavaScript项目的构建工具,也是基于node的一个命令行工具。很多开源JS项目都是使用它搭建。如jQuery、Qunit、CanJS等。它有以下作用
- 文件操作型:比如合并、压缩js和css文件等
- 预编译型:比如编译less、sass、coffeescript等
- 单元测试(基于QUnit)
- 类库项目构建型:比如 angular、ember、backbone等(这种推荐使用yeoman)
- 工程质量保障型:比如jshint、jasmine、mocha等
- 一句话:完全自动化(automation)
一、安装node
grunt依赖NodeJs和npm,请确保你的计算机已经安装该环境。
参考nodejs入门 (最新的node会自动安装npm)
二、安装grunt命令行工具grunt-cli
特别留意下grunt是有二个版本:服务器端版本(grunt)和客户端版本(grunt-cli),我们需要安装的是客户端版本。
使用-g全局安装,这样可以在任何一个目录里使用了。命令: npm install -g grunt-cli
需要注意的是在linux或mac下有时会报没有权限的错误,这时须在前面加一个sudo
,
安装后,可以查看改工具的版本。命令: grunt -version
(-g安装全局NodeJs模块,npm服务器有时会抽风,失败的多试几次)
如果你不慎安装了服务器端版,请现予以卸载:npm uninstall -g grunt
三、安装grunt及其插件
进入到某项目根目录,使用命令: npm install grunt --save-dev
此时,再查看grunt版本会多了一个4.0,如下
> E:\VirtualBox\ShareFolder\local.js.17173.com\GitHub\test\gruntjs>grunt -version
> grunt-cli v0.1.9
> grunt v0.4.1
四、使用Gruntjs来搭建一个前端项目,然后使用grunt合并,压缩JS文件。
大概有如下步骤
- 新建项目Bejs
- 新建文件package.json
- 新建文件Gruntfile.js
- 命令行执行grunt任务
1. 新建项目Bejs
源码放在src下,该目录有两个js文件,selector.js和ajax.js。编译后代码放在dest,这个grunt会自动生成。
2. 新建package.json
package.json放在根目录下,它包含了该项目的一些元信息,如项目名称、描述、版本号,依赖包等。它应该和源码一样被提交到svn或git。
package.json内容需符合JSON语法规范,如下
{
"name": "Bejs",
"version": "0.1.0",
"devDependencies": {
"grunt": "~0.4.0",
"grunt-contrib-jshint": "~0.1.1",
"grunt-contrib-uglify": "~0.1.2",
"grunt-contrib-concat": "~0.1.1"
}
}
留意
devDependencies
字段,定义你要拉取的依赖模块,上面的代码,拉取grunt-contrib-uglify
插件(用于压缩js),字段的值~0.1.2
,指明需要模块的版本号,“~”是至少的意思。
devDependencies中的grunt在前面已经安装了,grunt-contrib-jshint/grunt-contrib-uglify/grunt-contrib-concat则没有安装。三个分别对于三个任务(task)
- grunt-contrib-jshint js语法检查
- grunt-contrib-uglify 压缩,采用UglifyJS
- grunt-contrib-concat 合并文件
此时,打开命令行工具进入到项目根目录,敲如下命令: npm install grunt-contrib-jshint
再查看根目录,发现多了个node_modules目录,目录下多了一个 grunt-contrib-jshint 的目录。为了快速安装相关插件,可以在项目的根目录直接使用 npm install
命令直接安装所有的依赖插件。
3. 新建文件Gruntfile.js
Gruntfile.js也是放在项目根目录下,几乎所有的任务都定义在该文件中,它就是一个普通的js文件,里面可以写任意js代码而不仅局限于JSON。和package.json一样它也要和源码一样被提交到svn或git。
Gruntfile.js由以下内容组成
wrapper函数,结构如下,这是Node.js的典型写法,使用exports公开API
module.exports = function(grunt) { // Do grunt-related things in here };
项目和任务配置
- 载入grunt插件和任务
- 定制执行任务
该示例完成以下任务
- 合并src下的文件(ajax.js/selector.js)为domop.js
- 压缩domop.js为domop.min.js
- 这两个文件都放在dest目录下
最终的Gruntfile.js如下
module.exports = function(grunt) {
// 配置
grunt.initConfig({
pkg : grunt.file.readJSON('package.json'),
concat : {
domop : {
src: ['src/ajax.js', 'src/selector.js'],
dest: 'dest/domop.js'
}
},
uglify : {
options : {
banner : '/*! <%= pkg.name %> <%= grunt.template.today("yyyy-mm-dd") %> */\n'
},
build : {
src : 'dest/domop.js',
dest : 'dest/domop.min.js'
}
}
});
// 载入concat和uglify插件,分别对于合并和压缩
grunt.loadNpmTasks('grunt-contrib-concat');
grunt.loadNpmTasks('grunt-contrib-uglify');
// 注册任务
grunt.registerTask('default', ['concat', 'uglify']);
};
4. 执行grunt任务
打开命令行,进入到项目根目录,敲 grunt
从打印信息看出成功的合并和压缩并生成了dest目录及期望的文件,这时的项目目录下多了dest
ok,这里介绍了2个常见任务concat和uglify,jshint等没有介绍。Gruntfile.js里的代码也没有一一解读 更多帮助信息请查看–grunt任务配置详解,感兴趣的同学可在gruntjs的官方文档找到。