GruntJS

用GruntJS进行js代码压缩

为什么开发者要关心GruntJS？

主要的原因是开发者经常寻找自动化日常任务的方法，这有助于将出错的几率降到最低。手工从事重复无聊的任务的时候，我们很容易犯错。

GruntJS依赖

GruntJS要求 NodeJS 0.8.0以上版本。我们将使用 npm 包管理器来安装 GruntJS 和它的插件。新版的NodeJS默认包含 NPM 包管理器。可从官网下载最新版的 NodeJS。

GruntJS起步

在开始之前，我们需要理解Grunt的三大主要组成部分：

1. GruntJS CLI

GruntJS提供了GruntJS命令行工具。下面会提到安装 GruntJS CLI 的命令。如果你在安装时遇到错误信息，那么你可能需要 sudo 权限来运行这个命令。

1
npm install grunt-cli -g

上面的命令将全局安装 grunt-cli 包，这样在任何目录下都可以调用grunt命令。GruntJS CLI不包括grunt task runner。要使用 grunt task runner，我们需要将其作为应用的开发依赖安装。grunt和grunt-cli的分离确保每个团队的成员使用同一版本的grunt task runner。

2. GruntJS Task Runner

grunk命令会调用Grunt task runner。我们需要将其作为应用的开发依赖安装。让我们先开一个目录，放置我们的博客应用示例。

1
2
mkdir blog
cd blog

上面已经提到，Grunt要作为应用的开发依赖安装。所以我们需要创建一个定义应用元信息的package.json文件。运行npm init命令，回答一些问题即可创建package.json文件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
$ npm init
name: (blog) 
version: (0.0.0) 
description: My awesome blog
entry point: (index.js) 
test command: 
git repository: 
keywords: 
author: 
license: (BSD-2-Clause) 
About to write to /Users/shekhargulati/blog/package.json:
{
  "name": "blog",
  "version": "0.0.0",
  "description": "My awesome blog",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "BSD-2-Clause"
}
Is this ok? (yes) 
Shekhars-MacBook-Pro:blog shekhargulati$

完成这一步之后，init命令会为我们创建 package.json 文件。由于我们不需要 main、scripts、author和license这些项目，我们可以删掉它们。现在我们有了一个最简单的 package.json 文件。

1
2
3
4
5
{
  "name": "blog",
  "version": "0.0.0",
  "description": "My awesome blog"
}

运行下面的命令将Grunt安装到本地：

1
npm install grunt --save-dev

上面的命令将安装所需的依赖，同时也会更新 package.json。

1
2
3
4
5
6
7
8
{
  "name": "blog",
  "version": "0.0.0",
  "description": "My awesome blog",
  "devDependencies": {
    "grunt": "~0.4.1"
  }
}

3. Grunt Plugins

GruntJS有一个良好的插件体系，我们需要的大多数任务都有相应的插件加以处理。GruntJS的插件可以用npm安装。在这篇文章中，我们将使用两个插件——grunt-contrib-uglify和grunt-markdown。完整的插件列表在此。

Gruntfile

现在我们该告诉 GruntJS 该做哪些任务了。如果我们在blog目录中运行grunt命令，我们会看到如下的错误信息：

1
2
3
4
$ grunt
A valid Gruntfile could not be found. Please see the getting started guide for
more information on how to configure grunt: http://gruntjs.com/getting-started
Fatal error: Unable to find Gruntfile.

为了使用Grunt，我们需要创建一个名为Gruntfile.js的文件。Gruntfile指定grunt需要执行的任务。这个文件包含了构建脚本。

在blog目录下创建一个新文件，起名为 Gruntfile.js，加入下列代码：

1
2
3
module.exports = function(grunt){

};

这是我们开始使用Gruntfile所需的样板。

接着我们需要配置grunt需要执行的任务。我们调用grunt的initConfig函数，将配置对象传递给它。目前，配置对象是空白的。

1
2
3
4
5
module.exports = function(grunt){
    grunt.initConfig({

    })  
};

精简

我们要执行的第一项任务是精简应用中的javascript文件。在blog目录中创建一个js文件夹，然后创建一个名为app.js的新文件。

1
2
3
$ mkdir js
$ cd js
$ touch app.js

在文本编辑器中打开app.js，在其中加入如下内容。app.js文件有两个简单的方法hello和bye。

1
2
3
4
5
6
function hello(name){
    return "Hello, " + name;
}
function bye(name){
    return "Bye, " + name;
}

现在我们在grunt配置对象中添加uglify任务。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
module.exports = function(grunt) {

  grunt.initConfig({
    uglify: {
      build: {
        src: ['js/app.js'],
        dest: 'js/app.min.js'
      }
    }

  });

  grunt.loadNpmTasks('grunt-contrib-uglify');

  grunt.registerTask('default', ['uglify']);
};

上面的代码做了这些事：

  1. 我们配置了uglify任务，指定了源文件和目标文件。
  2. 接着我们加载了grunt-contrib-uglify插件。在运行grunt命令之前，确保插件已经安装。所有的grunt插件都可以通过npm安装。
  3. 最后，我们将这个uglify任务注册为我们的默认任务。当我们未指定任务名称而直接运行grunt命令的时候，Grunt将调用默认任务。

如果我们运行grunt命令，我们会碰到下面的信息：

1
2
3
4
>> Local Npm module "grunt-contrib-uglify" not found. Is it installed?
Warning: Task "uglify" not found. Use --force to continue.

Aborted due to warnings.

运行下面的命令安装grunt-contrib-uglify插件。

1
npm install grunt-contrib-uglify --save-dev

然后再次运行grunt命令，这次我们将看到成功的信息。

1
2
3
4
5
$ grunt
Running "uglify:build" (uglify) task
File "js/app.min.js" created.

Done, without errors.

它成功地创建了app.min.js文件。app.min.js如下所示，所有的空格被删除了，函数的参数被重构为单一字母，整个文件被压缩成一行。

function hello(a){return"Hello, "+a}function bye(a){return"Bye, "+a}