Benbria CoffeeCoverage 技术文档

1. 安装指南

首先，确保您的环境中已安装 Node.js。接下来，通过以下命令安装 Benbria CoffeeCoverage：

npm install --save-dev coffee-coverage

同时，为了生成覆盖率报告，您还需要安装 Istanbul：

npm install --save-dev istanbul

2. 项目的使用说明

Benbria CoffeeCoverage 用于对 CoffeeScript 文件进行代码覆盖率检测。以下是基本的使用流程：

• 将您的 CoffeeScript 文件放在 "test" 文件夹中。
• 运行以下命令，其中包含了 mocha 测试命令，并指定了需要编译的 CoffeeScript 文件：

mocha --recursive --compilers coffee:coffeescript/register --require coffee-coverage/register-istanbul test

• 运行 Istanbul 报告命令，生成覆盖率报告：

./node_modules/.bin/istanbul report

执行完以上步骤后，您将在 ./coverage/lcov-report/index.html 文件中找到生成的 Istanbul 覆盖率报告。

3. 项目API使用文档

Benbria CoffeeCoverage 提供了多种风格的代码覆盖率检测，包括 Istanbul、JSCoverage 和 Streamline 编译器风格。以下是部分 API 使用说明：

• 原生 CoffeeScript 代码覆盖率检测：不基于源映射（source maps）。
• 条件覆盖率检测：通过使用 pragmas 实现。
• 动态覆盖率检测：在运行时对代码进行检测。

4. 项目安装方式

如前所述，通过 npm 进行安装：

npm install --save-dev coffee-coverage
npm install --save-dev istanbul

安装完成后，您可以通过命令行工具或通过引入相关模块来使用 Benbria CoffeeCoverage。