@0xdoublesharp/doublcov
v0.4.3
Published
Find what's missing with static LCOV coverage reports
Downloads
1,517
Maintainers
Readme
Build from an existing lcov.info file or run one of the built-in coverage builders first:
npx @0xdoublesharp/doublcov build --lcov lcov.info --sources srcWhat You Get
- A portable static report directory you can upload to CI artifacts or any static host.
- Built-in builders for Foundry, Hardhat, Vitest, Jest, Node/V8, pytest, Rust coverage tools, and gcov/lcov.
- Source-level navigation for uncovered lines, branch/function totals, parser diagnostics, and historical coverage.
- A GitHub Action, npm package, standalone binaries, and Docker image for different project shapes.
Install
npm install --save-dev @0xdoublesharp/doublcovor:
pnpm add -D @0xdoublesharp/doublcovRun without installing:
npx @0xdoublesharp/doublcov buildor:
pnpm dlx @0xdoublesharp/doublcov buildThe executable is:
doublcovCommands
Build from existing LCOV:
doublcov build \
--lcov lcov.info \
--sources srcRun a builder and then build the report:
doublcov foundry -- --exclude-tests --ir-minimum
doublcov hardhat
doublcov vite
doublcov jest
doublcov v8
doublcov pytest
doublcov cargo-llvm-cov
doublcov cargo-tarpaulin
doublcov lcov-captureLocal builds open the generated index.html automatically. Open an existing report directory:
doublcov open coverage/reportFor large projects or hosted reports, generate split static assets:
doublcov build --mode static --no-open
doublcov open coverage/reportstandalone mode is the local default and writes a self-contained index.html that can be opened from disk. static mode is the CI default and writes index.html, assets, and lazy-loaded JSON files for GitHub Pages and other static hosts. doublcov open detects the report type: standalone reports open directly, and static reports are served on an available local port. Static preview runs in the foreground and stops automatically after 30 minutes unless extended from the browser.
Generic build defaults:
- LCOV path:
lcov.info - source path:
src - output directory:
coverage/report - history file:
.doublcov/history.json
Builder commands also read ecosystem config and place the report next to the resolved LCOV file when --out is not set.
Supported Builders
foundry/forge: runsforge coverage --report lcovhardhat: runsnpx hardhat coveragevite/vitest: runsnpx vitest run --coverage --coverage.reporter=lcovjest: runsnpx jest --coverage --coverageReporters=lcovc8/v8/node/node-test: runsnpx c8 --reporter=lcov node --testpytest/python/coverage.py: runspython -m pytest --cov --cov-report=lcov:<path>cargo-llvm-cov/llvm-cov/rust: runscargo llvm-cov --lcov --output-path <path>cargo-tarpaulin/tarpaulin: runscargo tarpaulin --out Lcovlcov-capture/lcov/gcov/c/cpp: runslcov --capturefor gcov-style C/C++ coverage data
For tools that always write lcov.info inside a report directory, --lcov must point to a path ending in lcov.info.
Pass arguments to the underlying builder after --:
doublcov forge -- --exclude-tests --ir-minimum
doublcov vite -- --runInBand
doublcov pytest -- tests/unit
doublcov cargo-llvm-cov -- --workspaceBuilder integrations are built into this CLI. Adding a new builder requires a code change in the repository.
Solidity
Foundry:
{
"scripts": {
"coverage": "doublcov forge -- --exclude-tests --ir-minimum",
"coverage:ci": "doublcov forge --no-open -- --exclude-tests --ir-minimum"
}
}Hardhat:
{
"scripts": {
"coverage": "doublcov hardhat",
"coverage:ci": "doublcov hardhat --no-open"
}
}From existing Hardhat LCOV:
npx hardhat coverage
doublcov build \
--lcov coverage/lcov.info \
--sources contracts \
--out coverage/reportJavaScript And TypeScript
doublcov vite
doublcov jest
doublcov v8v8 uses c8 around Node's built-in test runner. Or build from existing LCOV:
doublcov build \
--lcov coverage/lcov.info \
--sources src \
--extensions ts,tsx,js,jsx,mts,cts,mjs,cjs,vuePython, Rust, C, And C++
doublcov pytest
doublcov cargo-llvm-cov
doublcov cargo-tarpaulin
doublcov lcov-capture -- --rc branch_coverage=1These builders assume the ecosystem coverage tool is installed in the project or environment: pytest-cov for Python, cargo-llvm-cov or cargo-tarpaulin for Rust, and lcov plus compiler-generated gcov data for C/C++.
Diagnostics
Attach parser-tagged diagnostics:
doublcov build \
--diagnostic foundry-debug:coverage.debug \
--diagnostic foundry-bytecode:coverage.bytecodeFoundry aliases:
doublcov forge --debug coverage.debug --bytecode coverage.bytecodeThemes And UI Hooks
Attach declarative report customization:
doublcov build \
--customization doublcov.config.json \
--theme ci-darkCustomization JSON can set "open" to control whether the generated index.html opens after build or builder commands. It can also set lcov, out, sources, extensions, history, and name defaults, plus themes and declarative UI hook metadata for report:header, report:summary, file:toolbar, and sidebar:panel.
The CLI automatically loads doublcov.config.json from the current working directory when it exists. Use --customization <path> to override the path. An explicitly supplied customization path must exist.
Local builds open by default. CI and the GitHub Action default to --mode static --no-open. Use --mode, --open, or --no-open to override that behavior for one run.
Builder command defaults resolve from CLI flags first, then doublcov.config.json, then project config such as package.json, foundry.toml, Hardhat source paths, Jest/Vitest/c8 config, .solcover.js, or pyproject.toml. When no report output is configured, Doublcov writes the report to a report directory next to the resolved LCOV file.
Output Hosting
Standalone reports can be opened directly from disk. Static reports are better for large projects and can be uploaded to GitHub Pages, GitLab Pages, Netlify, Vercel, Cloudflare Pages, object storage, or CI artifacts.
GitHub Action
For non-Node projects, use the repository action to download the standalone binary in CI:
- uses: doublesharp/doublcov@v0
with:
command: build
args: --lcov coverage/lcov.info --sources src --out coverage/reportUse the moving major action ref for compatible action updates. Omit version
to download the latest GitHub Release binary, or set version: v0.4.3 to pin
the downloaded CLI binary for reproducible CI.
The action passes --no-open by default. Add --open to args only when the workflow intentionally has a browser-capable environment.
Distribution
npm is the primary distribution channel for the CLI. Tagged GitHub Releases publish standalone binaries and checksums, the root GitHub Action wraps those binaries for any-language CI, and the Docker image is published for containerized workflows.
Additional docs:
