
JS 代码覆盖率检测,简单来说,就是看看你的测试用例到底测到了多少代码。Istanbul (现在通常叫 nyc) 是个很棒的工具,能帮你统计这个。
Istanbul 统计测试用例的覆盖范围
首先,你需要安装 nyc 和你用的测试框架,比如 Jest 或者 Mocha。 假设你用的是 Jest,那么:
npm install --save-dev nyc jest
然后,在你的
package.json
{
"scripts": {
"test": "nyc jest"
}
}跑
npm test
coverage
index.html
覆盖率上不去,可能有很多原因。最常见的是,有些代码根本没被测试用例执行到。比如,一些错误处理的代码,只有在特定情况下才会触发。还有一些代码,可能是过时的,根本没用到了。
解决办法也很简单,就是仔细分析覆盖率报告,看看哪些代码没测到,然后针对性地写测试用例。如果发现有没用的代码,直接删掉就好。
有些文件,比如配置文件、第三方库,或者一些工具脚本,可能不需要覆盖率检测。这个时候,你可以在
package.json
nyc
{
"nyc": {
"exclude": [
"config/",
"node_modules/",
"scripts/"
]
}
}这样,
nyc
config
node_modules
scripts
在 CI/CD 环境中,通常需要生成覆盖率报告,并上传到代码托管平台,比如 GitHub 或者 GitLab。这样,每次提交代码的时候,就能自动检查覆盖率是否达标。
以 GitHub Actions 为例,你可以创建一个
coverage.yml
name: Code Coverage
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
coverage:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Use Node.js 16
uses: actions/setup-node@v3
with:
node-version: 16
- run: npm install
- run: npm test
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v3
with:
token: ${{ secrets.CODECOV_TOKEN }}
flags: unittests
name: codecov-umbrella这个配置会监听
main
为了防止代码质量下降,可以设置覆盖率阈值。比如,要求代码覆盖率必须达到 80% 以上。如果覆盖率低于这个阈值,就认为测试不通过。
在
package.json
nyc
check-coverage
{
"nyc": {
"check-coverage": true,
"statements": 80,
"branches": 80,
"functions": 80,
"lines": 80
}
}这样,每次运行测试的时候,
nyc
在 TypeScript 项目中使用 Istanbul (nyc) 稍微麻烦一点,因为需要先将 TypeScript 代码编译成 JavaScript 代码,才能进行覆盖率检测。
首先,你需要安装
ts-node
@types/jest
npm install --save-dev ts-node @types/jest
然后,修改你的
jest.config.js
ts-node
module.exports = {
preset: 'ts-jest',
testEnvironment: 'node',
};最后,修改你的
package.json
nyc
{
"scripts": {
"test": "nyc --extension .ts jest"
}
}这样,
nyc
以上就是JS 代码覆盖率检测 - 使用 Istanbul 统计测试用例的覆盖范围的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号