ready.js 项目技术文档

1. 安装指南

安装准备

在安装 ready.js 之前，请确保您的系统已经安装了 Node.js 和 npm。如果尚未安装，请先安装它们。

安装步骤

1. 打开终端或命令行工具。
2. 运行以下命令以全局安装 ready.js：

   npm install ready.js --global
   

2. 项目的使用说明

基本用法

ready.js 是一个用于 JavaScript 持续集成的工具，主要功能包括：

1. 使用 jshint 检查 JavaScript 文件的有效性。
2. 使用 Uglify JS 编译 JavaScript 文件。
3. （后续功能）在编码时监视 JavaScript 文件的 jshint 检查。
4. 创建所有 JavaScript 文件的聚合文件。

命令行选项

readyjs [FILES OR DIRECTORIES] [options]

常用选项

• -o, --output：指定输出文件或目录。
• -c, --config：指定配置文件。
• -i, --ignore：忽略这些文件进行 JSHint 检查，但在聚合文件中输出它们。
• -k, --keep：保留单独的压缩文件。
• --no-recursive：不递归子目录。
• -h, --help：显示帮助信息。
• -v, --version：显示当前版本。

示例

readyjs path/to/src -o path/to/dest

3. 项目API使用文档

API 参考

ready.js 提供了一个名为 readyjs.compile 的函数，用于编译 JavaScript 文件。

函数签名

readyjs.compile(sources, [options], callback(err, minified))

参数说明

• sources：要编译的文件或目录列表。
• options：可选参数，配置编译行为。
• callback(err, minified)：回调函数，处理编译结果。

示例

ready.compile(['./js', 'lib/cat.js'], {analyze:false}, function(err, minified) {
    // 处理编译结果
});

options 参数

• ignore：默认值为 []，忽略的文件列表。
• analyze：默认值为 true，是否通过 jshint 分析文件。
• recursive：默认值为 true，是否递归目录。

callback(err, minified) 参数

• err：发生的错误。如果 jshint 未通过，err 将包含格式化的 jshint 错误。
• minified：所有文件的聚合压缩代码。

4. 项目安装方式

全局安装

npm install ready.js --global

本地安装

如果您不想全局安装，也可以在项目目录下本地安装：

npm install ready.js --save-dev

配置文件

您可以使用 JSON 格式的配置文件来配置 ready.js。配置文件的格式如下：

{
  "output": "path/to/destination",
  "ignore": [],
  "keep": false,
  "no-recursive": false
}

持续集成

在持续集成环境中，您可以在 pre-commit 钩子中运行 ready.js：

echo 'readyjs path/to/src -o path/to/dest' >> .git/hooks/pre-commit

5. 贡献指南

贡献代码

1. 在 GitHub 上 fork ready.js 项目。
2. 克隆您的 fork 到本地环境：

   git clone [e-mail]:USERNAME/ready.js.git
   

3. 创建一个新分支：

   git checkout -b your_branch_name
   

4. 编写代码并提交更改：

   git commit -am "A descriptive message"
   

5. 将分支推送到您的 fork：

   git push origin your_branch_name
   

6. 在 GitHub 上创建拉取请求。

创建问题

如果您遇到问题或有建议，可以在 GitHub 上创建问题。

6. 需要更多帮助？

如果您需要更多帮助，可以创建问题或发送电子邮件至 [e-mail]。