Istanbul.js nyc代码覆盖率测试工具配置指南

Istanbul.js nyc代码覆盖率测试工具配置指南

【免费下载链接】nycthe Istanbul command line interface项目地址: https://gitcode.com/gh_mirrors/ny/nyc

Istanbul.js是一个强大的JavaScript代码覆盖率测试工具，其命令行界面nyc能够帮助开发者测量单元测试覆盖代码的哪些部分。通过nyc，您可以获取详细的覆盖率报告，优化测试用例质量，提升代码可靠性。

项目概述

nyc是Istanbul.js的命令行客户端，支持多种JavaScript测试框架，包括tap、mocha、AVA等。它能够：

• 支持生成子进程的应用程序
• 提供Babel和TypeScript项目的源码映射覆盖率
• 通过行计数器检测ES5和ES2015+ JavaScript代码

环境准备

在开始配置nyc之前，请确保您的开发环境满足以下要求：

• Node.js环境 - 推荐使用18及以上版本
• npm包管理器 - 确保版本兼容性

验证安装状态只需在终端运行：

node -v && npm -v

快速安装

安装nyc依赖

使用npm安装nyc作为开发依赖：

npm install --save-dev nyc

或者使用yarn：

yarn add --dev nyc

配置测试脚本

在package.json文件中添加覆盖率测试命令：

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

核心配置方法

配置文件格式

nyc支持多种配置文件格式：

基础配置示例

在项目根目录创建.nycrc文件：

{ "reporter": ["text", "html"], "report-dir": "./coverage", "all": true }

高级配置选项

nyc.config.js配置示例：

'use strict' const isWindows = require('is-windows')() module.exports = { exclude: [ 'coverage', 'self-coverage', 'test/fixtures/coverage.js', 'test/build/*', 'test/src/*', 'test/nyc.js', 'test/process-args.js', 'test/fixtures/_generateCoverage.js' ], 'check-coverage': !isWindows, branches: 100, functions: 100, lines: 100, statements: 100 }

Istanbul.js代码覆盖率测试报告展示

文件选择配置

包含和排除规则

nyc默认只收集测试过程中访问的源文件的覆盖率。您可以通过配置include和exclude数组来精确控制检测范围：

{ "all": true, "include": [ "src/**/*.js" ], "exclude": [ "**/*.spec.js" ] }

默认排除规则

nyc会自动将**/node_modules/**添加到排除列表中。如果需要覆盖此行为，可以设置：

{ "all": true, "include": [ "lib/**", "node_modules/@my-org/**" ], "exclude": [ "node_modules/@my-org/something/unwanted.js", "**/test/**" ], "excludeNodeModules": false }

覆盖率阈值设置

自定义覆盖率标准

您可以设置自定义覆盖率阈值，当check-coverage设置为true且覆盖率低于阈值时构建将失败：

{ "branches": 80, "lines": 80, "functions": 80, "statements": 80 }

高低水位线配置

为覆盖率报告设置自定义高低水位线：

{ "watermarks": { "lines": [80, 95], "functions": [80, 95], "branches": [80, 95], "statements": [80, 95] } }

多测试运行器集成

合并多个测试报告

如果项目中有不同的测试运行器或不同类型的测试运行，nyc可以自动合并覆盖率报告：

{ "scripts": { "cover": "npm run cover:unit && npm run cover:integration && npm run cover:report", "cover:unit": "nyc --silent npm run test:unit", "cover:integration": "nyc --silent --no-clean npm run test:integration", "cover:report": "nyc report --reporter=lcov --reporter=text" } }

源码映射支持

对于预检测的代码库，nyc支持内联源码映射和.map文件。重要提示：如果使用nyc与预检测代码的项目，请将配置选项--exclude-after-remap设置为false。

缓存配置

nyc默认会将检测的文件缓存到磁盘，以防止多次检测源文件并加快执行速度。您可以通过运行nyc时使用--cache false标志来禁用此行为。

运行覆盖率测试

配置完成后，运行覆盖率测试：

npm run coverage

测试完成后，在coverage目录下查看详细的HTML报告，直观展示代码覆盖情况。

实用技巧

忽略代码行

在代码中使用以下解析提示来忽略特定行：

• /* istanbul ignore if */：忽略下一个if语句
• /* istanbul ignore else */：忽略if语句的else部分
• /* istanbul ignore next */：忽略源代码中的下一个"事物"
• /* istanbul ignore file */：忽略整个源文件

忽略类方法

在nyc配置中通过ignore-class-method数组忽略特定方法：

{ "ignore-class-method": ["render"] }

通过以上配置指南，您可以快速掌握Istanbul.js nyc的核心配置方法，提升代码测试质量和开发效率。

【免费下载链接】nycthe Istanbul command line interface项目地址: https://gitcode.com/gh_mirrors/ny/nyc