覆盖参数
一个用于解析报道的Node.js库.
这个库将不同的覆盖解析器以统一的方式解析覆盖信息. 支持的覆盖面报告格式:
注:如果想要合并解析结果,可以使用 @ connectionis/coverage-并购。 。 。 .
示例
const coverageParser = require('@connectis/coverage-parser');
coverageParser
.parseGlobs('**/lcov.info', {
type: 'lcov'
})
.then(results => console.log(results));
API 密码
API包括以下内容:
- 解析Globs( globs, 选项)
- 解析文件( 文件, 选项)
- 解析文件( 文件, 选项)
- 类型
类型
类型 Array<string>
可用剖析器类型的矩阵 .
选项
类型 object
选项。 类型
类型 : string
用于解析覆盖文件的解析器类型 。 见导出 types 可用类型的数组.
选项.parser
类型 : function
自定义解析覆盖文件的函数 : (file) => Promise<Array<CoverageResult>>. 见下文.
选项。pathMode
类型 : 'absolute' | 'relative' | 'unmodified'
默认 : 'absolute'
解析结果中应当使用的路径类型 。 见 options.baseDir。 。 。 .
选项。baseDir
类型 : string
默认 : process.cwd()
用于在覆盖报告中制作相对或绝对路径的基础目录。 见 options.pathMode。 。 。 .
解析Globs( globs, 选项)
查找符合光标模式的所有覆盖报告,并解析结果.
缩写
类型 : Array<string>|string
要么 模糊图案 或单一的光彩图案.
选项
类型 : options。见上文.
选项. glob 选项
类型 : object
要传递给的选项 快速块。 。 。 .
返回时
类型 : Promise<Array<CoverageResult>>. 见下文.
解析文件( 文件, 选项)
解析所有覆盖报告文件 .
文件
类型 : Array<string>
一系列文件路径 .
选项
类型 : options。见上文.
返回时
类型 : Promise<Array<CoverageResult>>. 见下文.
解析文件( 文件, 选项)
解析覆盖报告文件 .
文件
类型 : string
文件路径.
选项
类型 : options。见上文.
返回时
类型 : Promise<Array<CoverageResult>>. 见下文.
覆盖范围
返回的数据格式如下.
{
"title": "Test #1",
"file": "/some/absolute/path/anim-base/anim-base-coverage.js",
"functions": {
"hit": 23,
"found": 29,
"details": [
{
"name": "(anonymous 1)",
"line": 7,
"hit": 6
},
{
"name": "(anonymous 2)",
"line": 620,
"hit": 225
},
{
"name": "_end",
"line": 516,
"hit": 228
}
]
},
"lines": {
"found": 181,
"hit": 143,
"details": [
{
"line": 7,
"hit": 6
},
{
"line": 29,
"hit": 6
},
{
"line": 41,
"hit": 0
}
]
},
"branches": {
"found": 2,
"hit": 1,
"details": [
{
"line": 9,
"branch": 0,
"taken": 0
},
{
"line": 9,
"branch": 1,
"taken": 1
}
]
}
}