基于Grunt构建一个JavaScript库

现在公认的JavaScript典型项目需要运行单元测试，合并压缩。有些还会使用代码生成器，代码样式检查或其他构建工具。

Grunt.js是一个开源工具，可以帮助你完成上面的所有步骤。它非常容易扩展，并使用JavaScript书写，所以任何为JavaScript库或项目工作的人都可以按自己的需要扩展它。

本文解释如何使用Grunt.js构建JavaScript库。Grunt.js依赖Node.js和npm，所以第一节解释其是什么，如何安装和使用。如果你对npm有了解，那你可以跳过这一节。第四和第五节讲述如何配置Grunt和一系列典型Grunt任务。

本文讨论的代码例子可以在GitHub上访问。

工具概述（Tool Chain Overview）

开始之前，我们需要三个工具：

• Node.js,
• Npm,
• Grunt.js.

Node.js是一个流行的服务器端JavaScript环境。它被用来编写和运行JavaScript服务和JavaScript命令行工具。如果你想进一步链接Node.js，你可以查看Stack Overflow上相关的资料。

Npm是Node.js的包管理工具。它能从中心仓库下载依赖，解决大部分依赖冲突问题。Npm仓库仅仅存储Node.js服务器段和命令行项目。它不包含用于web和移动app相关的库。我们用它来下载Grunt.js。

Grunt.js是一个任务运行工具，我们用起构建我们的项目。它在Node.js之上运行并且通过Npm安装。

安装Node.js和Npm（Node.js and Npm Installation）

你可以直接从下载页面或用其它包管理工具安装node.js。安装成功后在命令行输入 node -v Node.js将输出它的版本号。

大部分安装器和包管理工具将同时安装Npm。在命令行输入 npm -v 测试是否安装成功。如果成功将输出它的版本号。不同的系统可能安装方式略有不同。

Linux

下载和使用安装脚本。

Windows

windows安装器包含npm并会添加path变量。仅在你下载Node.exe或从源代码编译Node是才需要独立安装Npm。从这里下载Npm的最新版zip压缩包。解压后赋值到Node.exe的安装目录。如果你愿意，你也可以放到任何位置，将其加入path变量即可。

OSX

安装包中内建Npm。

Npm基础（Npm Basics）

了解Npm基础操作对于使用和安装Grunt.js都有帮助。这节仅包含接触知识。更多细节可以查看npm文档。

本节将解释下面的东西：

• 什么是npm；
• npm插件本地安装和全局安装的区别；
• package.json文件和其规范；
• npm安装命令。

概要（Overview）

Npm是一个包管理工具，可以从中心仓库下载和安装JavaScript依赖。安装包能被用在Node.js项目或命令行工具。

项目通常在package.json文件内部列出其依赖和安装插件。此外npm库也可以从命令行安装。

全局安装vs本地安装（Global vs Local Installation）

每个包可以安装在全局或本地环境。实际的区别是存储位置和访问方式。

全局安装包被直接存储在Node.js安装路径。他们之所以被称为全局，是因为他们可以在任何地方直接访问。

本地安装将下载包安装在当前工作路径。本地安装包只能从其所在目录访问。

本地安装包被存储进node_mudules子目录。无论你使用什么版本控制系统，你可以将其添加仅.ignorefile 文件。

Package.json

package.json文件包含npm项目描述。它总是位于项目的根目录，并且包含项目名称，版本，协议和其他类似元数据。最重要的是，它包含两个项目依赖列表。

 第一个列表包含运行所需要的依赖。任何希望使用此项目的人必须安装它们。第二个列表包含开发时需要依赖项。包括测试工具，构建工具和代码样式检测工具。

创建package.json最简单的方法是通过 npm install 命令。这条命令会以交互式提问一系列问题，并根据回答在当前工作目录生成基本的package.json文件。只有名字（name）和版本（version）属性是必须的。如果你不打算将你的库发布到Npm，你能忽略其余的部分。

下面的链接包含对package.json的详细描述：

• package.json interactive guide;
• package.json tutorial on nodejitsu;
• official documentation.

安装命令（The Install Command）

Npm宝可以通过npm install 命令安装。默认安装到本地。全局安装需要指定 -g开关。

不带参数的 npm install 将在当前目录或上层目录查找 package.json 文件。如果发现，将会在当前目录安装所有列出的依赖项。

可以通过 npm install <pkg_name@version> 命令安装具体的npm包。这条命令将从中心仓库找到指定版本的包，并将其安装到当前目录。

版本号是可选的。如果省略将下载最新稳定版。

最后，通过 --sace-dev开关不仅可以安装包，还会将其添加到 package.json 的开发依赖中。

为项目添加Grunt.js（Adding Grunt.js to the Project）

我们将首先将Grunt.js添加进我们的JavaScript项目。为此我们需要安装两个Grunt.js模块：

• grunt-cli - 命令行接口 (CLI);
• grunt - 任务运行器.

提醒：最新的Grunt.js（4.0）不再兼容以前的版本。一些老的教程和文档不再适合新版Grunt.js了。

概论（Overview）

所有实际的工作是由任务运行器来做。命令行接口仅解析参数和将其传递个任务运行器。如果任务运行器没有安装将不会做任何事情。

命令行接口应该被安装在全局环境，然而任务运行器在本地环境。全局命令行接口保证Grunt命令可以在所有路径访问。任务运行器必须是本地的，因为不同的项目可能需要不同的Grunt版本。

安装（Installation）

安装全局Grunt命令行接口：

npm install -g grunt-cli 

切换到项目根目录，通过npm init让Npm帮你生成package.json文件。它会问你些问题然后根据你的回答生成合法的package.json文件。只有名字和版本是必须的；你可以忽略其他选项。

将Grunt.js最新版添加到本地环境，同时添加到package.json文件的开发依赖里。

npm install grunt --save-dev 

Package.json

通过前面的命令创建的package.json文件应该类似相面这样：

{
  "name": "gruntdemo",
  "version": "0.0.0",
  "description": "Demo project using grunt.js.",
  "main": "src/gruntdemo.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": "",
  "author": "Meri",
  "license": "BSD",
  "devDependencies": {
    "grunt": "~0.4.1"
  }
}

配置Grunt.js（Configure Grunt.js）

Grunt.js运行任务并且通过任务完成工作。然而，Grunt.js安装成功后还没有任务可以使用。任务必须从插件载入，而插件通常需要Npm安装。

我们使用五个插件：

• grunt-contrib-concat - 拼接文件,
• grunt-contrib-uglify - 拼接并压缩文件（js）,
• grunt-contrib-copy - 复制文件,
• grunt-contrib-qunit - 运行单元测试,
• grunt-contrib-jshint - 检查bug和JavaScript代码风格.

本节将解释如何配置这些插件。我们从最简单的配置开始，然后一步步解释如何配置任务。余下的子章节将详细讲解如何配置每个插件。

基础-不做任何配置（Basic Do Nothing Configuration）

Grunt将配置信息写到Gruntfile.js或Gruntfile.coffee文件里。由于我们创建的JavaScript项目，我们将使用JavaScript版本。最简单的Gruntfile.js看起来像下面这样：

//包装函数 有一个参数
module.exports = function(grunt) {

  // 默认任务。在本例子中没有任何操作。
  grunt.registerTask(‘default‘, []);
};

配置信息被保存在module.exports函数内部。它包含grunt对象作为其参数，并且通过调用该函数完成配置。

配置函数必须创建至少一个任务别名，并且配置他们。例如，上面的代码片段创建了一个“default”任务别名并且指定为空的任务列表。换句话说，默认的任务别名可以工作，但不会做任何事情。

用 grunt <taskAlias> 命令运行指定的 taskAlias任务。taskAlias的参数是可选的，如果省略，Grunt将使用“default”任务。

保存Gruntfile.js文件，在命令行运行Grunt：

grunt

你应该看到如下输出：

Done, without errors.

如果配置任务返回错误或警告Grunt将发出蜂鸣声（在命令行下输入错误的声音，译者未发现这点）。如果你不想听到蜂鸣声，你可以使用 -no-color 参数：

grunt -no-color

Grunt Npm 任务（Grunt Npm Tasks）

从插件添加任务是通过用步骤，对所有插件都是相同的。本节将概要讲述需要的过程，实际的例子将在下面的章节讲解。

安装插件（Install the Plugin）

首先，我们需要将插件添加进package.json文件的开发依赖里面，并且使用Npm进行安装：

npm install <plugin name> --save-dev 

配置任务（Configure Tasks）

任务配置必须被存储在一个对象内部，有各自的任务名，并且被传递给 grunt.initConfig方法：

module.exports = function(grunt) {

  grunt.initConfig({
    firstTask : { /* ... 配置第一个任务 ... */ },
    secondTask : { /* ... 配置第二个任务 ... */ },
    // ... 其他任务 ...
    lastTask : { /* ... 最后一个任务 ... */ }
  });

  // ... the rest ... 
};

全面的任务配置信息解释看这里Grunt.js文档。本节仅描述最通用，简单的例子。假设任务接受一个文件列表，并处理他们，然后生出输出文件。

一个简单的任务配置例子：

firstTask: {
  options: {
    someOption: value //取决于插件
  },
  target: {
    src: [‘src/file1.js‘, ‘src/file2.js‘], //输入文件
    dest: ‘dist/output.js‘ // 输出文件
  }
}

例子中的任务配置有两个属性。一个是任务选项，名称必须是”options“。Grunt.js不会对options的属性执行任何操作，其行为有插件决定。

其他项可以有任何名字，并且要包含任务目标。最常见的任务是操作和生成文件，所以他们的target有两个属性，”src“ 和 ”dest“。src包含输入的文件列表，dest包含输出的文件名字。

如果你配置多个任务，Grunt将依次执行。下面的任务将运行两次，一次操作src及其子目录的所有js文件，另一次操作test及其子目录下的所有js文件：

multipleTargetsTask: {
  target1: { src: [‘src/**/*.js‘] },
  target2: { src: [‘test/**/*.js‘]] }
} 

加载和注册任务（Load and Register Tasks）

最后，将插件载入必须使用 grunt.loadNpmTasks 函数，并且注册任务别名。

上面介绍的结构合起来如下：

module.exports = function(grunt) {

  grunt.initConfig({ /* ... tasks configuration ... */ });
  grunt.loadNpmTasks(‘grunt-plugin-name‘);
  grunt.registerTask(‘default‘, [‘firstTask‘, ‘secondTask‘, ...]);

};

配置JSHint（Configure JSHint）