Coverage
Code coverage metrics that measure the extent to which source code is executed during testing.
Coverage
Code coverage metrics that measure the extent to which source code is executed during testing.
Properties
id(string): Unique identifier for the coverage report.test([[Test]]): The test that generated this coverage, if applicable.suite([[TestSuite]]): The test suite that generated this coverage, if applicable.testRun([[TestRun]]): The test run that generated this coverage.commit([[Commit]]): The code commit being measured.branch([[Branch]]): The branch being measured.timestamp(number): Unix timestamp when coverage was measured.overall(number): Overall coverage percentage (0-100).lines(number): Line coverage percentage (0-100).linesCovered(number): Number of lines covered by tests.linesTotal(number): Total number of executable lines.linesUncovered(number): Number of lines not covered by tests.statements(number): Statement coverage percentage (0-100).statementsCovered(number): Number of statements covered.statementsTotal(number): Total number of statements.statementsUncovered(number): Number of statements not covered.branches(number): Branch coverage percentage (0-100).branchesCovered(number): Number of branches covered.branchesTotal(number): Total number of branches.branchesUncovered(number): Number of branches not covered.functions(number): Function coverage percentage (0-100).functionsCovered(number): Number of functions covered.functionsTotal(number): Total number of functions.functionsUncovered(number): Number of functions not covered.classes(number): Class coverage percentage (0-100).classesCovered(number): Number of classes covered.classesTotal(number): Total number of classes.classesUncovered(number): Number of classes not covered.files(number): File coverage percentage (0-100).filesCovered(number): Number of files with any coverage.filesTotal(number): Total number of files.filesUncovered(number): Number of files with no coverage.complexity(number): Cyclomatic complexity of covered code.fileCoverage(object[]): Per-file coverage details.directoryCoverage(object[]): Per-directory coverage details.uncoveredLines(number[][]): Line ranges not covered (start, end pairs).uncoveredFiles(string[]): File paths with no coverage.hotspots(object[]): Critical areas with low coverage.trend(string): Coverage trend (increasing, decreasing, stable).previousCoverage(number): Coverage percentage from previous run.coverageDelta(number): Change in coverage from previous run.threshold(number): Minimum coverage threshold required (0-100).meetsThreshold(boolean): Whether coverage meets or exceeds threshold.reportUrl(string): URL to detailed coverage report.reportFormat(string): Format of coverage report (lcov, cobertura, json, html).reportPath(string): Path to coverage report file.tool(string): Coverage tool used (jest, vitest, nyc, istanbul, jacoco).excludedPaths(string[]): Paths excluded from coverage analysis.includedPaths(string[]): Paths included in coverage analysis.metadata(object): Set of key-value pairs for storing additional information.
Actions
measure
Measure code coverage for a test execution.
Input: [[CoverageRequest]]
Output: [[Coverage]]
compare
Compare coverage across multiple runs.
Input: [[Coverage]][]
Output: [[CoverageComparison]]
analyze
Analyze coverage and identify gaps.
Input: [[Coverage]]
Output: [[CoverageAnalysis]]
generateReport
Generate a detailed coverage report.
Input: [[Coverage]]
Output: [[CoverageReport]]
identifyGaps
Identify uncovered code areas.
Input: [[Coverage]]
Output: [[CoverageGap]][]
exportReport
Export coverage report in specified format.
Input: [[Coverage]]
Output: [[File]]
setThreshold
Set minimum coverage threshold.
Input: [[CoverageThreshold]]
Output: [[Coverage]]
track
Track coverage trends over time.
Input: [[Coverage]]
Output: [[CoverageTrend]]
Events
measured: Triggered when coverage is measured.improved: Triggered when coverage increases.decreased: Triggered when coverage decreases.thresholdMet: Triggered when coverage meets threshold.thresholdNotMet: Triggered when coverage falls below threshold.Gap.identified: Triggered when an uncovered area is identified.Report.generated: Triggered when a coverage report is generated.Trend.analyzed: Triggered when coverage trends are analyzed.