Skip to content

GenerateCoverageBadgeOptions

Options for generateCoverageBadge.

Import:

import type { GenerateCoverageBadgeOptions } from '@mnaoumov/obsidian-dev-toolkit/test-runners/coverage-badge';

Signature:

export interface GenerateCoverageBadgeOptions

Properties

PropertyTypeDescription
label?stringThe text on the left half of the badge.
lcovPath?stringThe lcov report to read, relative to the project root.
metric?CoverageBadgeMetricWhich coverage figure the badge shows.
outputPath?stringWhere to write the SVG, relative to the project root. The default sits beside the report, in a folder a project ignores, so a local coverage run never leaves a changed file behind.

Links to this page: