UNPKG

1.78 kBJavaScriptView Raw
1export { default as coverageSupported } from './coverageSupported.mjs';
2export { default as coverageSupportedMinNodeVersion } from './coverageSupportedMinNodeVersion.mjs';
3export { default as analyseCoverage } from './analyseCoverage.mjs';
4export { default as reportCoverage } from './reportCoverage.mjs';
5
6/**
7 * [Node.js generated V8 JavaScript code coverage data](https://nodejs.org/api/cli.html#cli_node_v8_coverage_dir)
8 * analysis; useful for reporting.
9 * @kind typedef
10 * @name CoverageAnalysis
11 * @type {object}
12 * @prop {number} filesCount Number of files analyzed.
13 * @prop {Array<string>} covered Covered file absolute paths.
14 * @prop {Array<SourceCodeRanges>} ignored Ignored source code ranges.
15 * @prop {Array<SourceCodeRanges>} uncovered Uncovered source code ranges.
16 */
17
18/**
19 * A semantic version.
20 * @kind typedef
21 * @name SemanticVersion
22 * @type {object}
23 * @prop {number} major Major version.
24 * @prop {number} minor Minor version.
25 * @prop {number} patch Patch version.
26 * @prop {string} [prerelease] Prerelease version.
27 * @prop {string} [build] Build metadata.
28 */
29
30/**
31 * Source code location.
32 * @kind typedef
33 * @name SourceCodeLocation
34 * @type {object}
35 * @prop {number} offset Character offset.
36 * @prop {number} line Line number.
37 * @prop {column} column Column number.
38 */
39
40/**
41 * Source code range details.
42 * @kind typedef
43 * @name SourceCodeRange
44 * @type {object}
45 * @prop {boolean} [ignore] Should it be ignored.
46 * @prop {SourceCodeLocation} start Start location.
47 * @prop {SourceCodeLocation} end End location.
48 */
49
50/**
51 * A source code file with ranges of interest.
52 * @kind typedef
53 * @name SourceCodeRanges
54 * @type {object}
55 * @prop {string} path File absolute path.
56 * @prop {Array<SourceCodeRange>} ranges Ranges of interest.
57 */