Istanbul 命令行界面（nyc）使用教程

Istanbul 命令行界面（nyc）使用教程

nyc the Istanbul command line interface 项目地址: https://gitcode.com/gh_mirrors/ny/nyc

1. 项目介绍

Istanbul 是一个用于 JavaScript 代码覆盖率测试的工具，它通过为 ES5 和 ES2015+ 的 JavaScript 代码添加行计数器，来跟踪单元测试对代码库的覆盖情况。nyc 是 Istanbul 的命令行客户端，可以与多种 JavaScript 测试框架（如 tap、mocha、AVA 等）配合使用。

2. 项目快速启动

首先，使用包管理器将 nyc 添加为开发依赖：

npm i -D nyc
# 或者
yarn add -D nyc

在 package.json 中配置脚本，以便使用 nyc 调用 npm 脚本：

{
  "scripts": {
    "test": "mocha",
    "coverage": "nyc npm run test"
  }
}

也可以使用 npx 而不安装 nyc 作为依赖，但可能会获取到您尚未准备好的更新。为了解决这个问题，可以通过指定版本（例如 nyc@14）来固定到一个具体的 major 版本。

{
  "scripts": {
    "test": "npx nyc@latest mocha"
  }
}

3. 应用案例和最佳实践

Babel 项目

对于 Babel 项目，建议使用预配置的 @istanbuljs/nyc-config-babel。可以根据需要添加自定义配置选项。

TypeScript 项目

对于 TypeScript 项目，建议使用预配置的 @istanbuljs/nyc-config-typescript。添加你的覆盖配置：

{
  "extends": "@istanbuljs/nyc-config-typescript",
  "all": true,
  "check-coverage": true
}

配置文件

任何可以通过命令行设置的配置选项也可以在 package.json 的 nyc 部分、.nycrc 文件或其它支持的文件格式中指定。

4. 典型生态项目

Istanbul/nyc 可以与许多 JavaScript 项目和框架集成，例如：

• 与前端框架（如 React、Vue、Angular）一起使用的单元测试。
• 在 Node.js 应用程序中，与 Express 或 Koa 框架一起进行端到端测试。
• 与持续集成（CI）系统（如 Jenkins、Travis CI）集成，以自动执行测试并生成覆盖率报告。

通过这些集成，nyc 帮助开发者确保他们的代码质量，并且可以通过覆盖率报告来识别需要额外测试的代码区域。

nyc the Istanbul command line interface 项目地址: https://gitcode.com/gh_mirrors/ny/nyc