generate-test-coverage-report

Aggregate Vitest coverage metrics into a markdown report with mermaid visualizations.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/sneat-co/sneat-apps --skill generate-test-coverage-report
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: generate-test-coverage-report
Source: https://github.com/sneat-co/sneat-apps/tree/main/.github/skills/generate-test-coverage-report
Command: npx skills add https://github.com/sneat-co/sneat-apps --skill generate-test-coverage-report

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate comprehensive test coverage documentation for a workspace, consolidating metrics and visualizations to ease quality assessment.

Core Features & Use Cases

  • Collects coverage data from Vitest, aggregates metrics across projects, and generates a markdown report at /docs/test-coverage.md.
  • Renders visualizations (mermaid charts) for top uncovered lines, functions, and branches to highlight hotspots.
  • Supports configurable top-N rankings and a practical workflow for CI/CD quality gates.

Quick Start

Run the generation script to update the test coverage report for your workspace.

Frequently Asked Questions about generate-test-coverage-report

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a test coverage report for a Vitest workspace?

To generate a test coverage report, this Skill aggregates Vitest coverage data from coverage-final.json or coverage-summary.json files and outputs a consolidated markdown report at /docs/test-coverage.md.

How does test coverage visualization work for identifying uncovered code?

Test coverage visualization renders mermaid charts highlighting top uncovered lines, functions, and branches, translating raw coverage metrics into visual hotspots for quick quality assessment.

Can I use this to aggregate coverage metrics across multiple projects?

Yes, you can aggregate coverage metrics across multiple projects in a workspace by reading the coverage data from each project's respective coverage/ directory and consolidating it into a single report.

What coverage data formats are needed to generate the mermaid visualizations?

The mermaid visualizations require Vitest coverage data in JSON format, specifically reading from the coverage-final.json or coverage-summary.json files located inside the project coverage directories.

Does this test coverage report generation support CI/CD quality gates?

Yes, the report generation supports a practical workflow for CI/CD quality gates by providing configurable top-N rankings of uncovered areas to monitor code quality thresholds during pipeline execution.

How do I configure top-N rankings for uncovered code hotspots?

You can configure top-N rankings for uncovered code hotspots when generating the report, allowing you to limit the mermaid visualizations to the most critical uncovered lines, functions, and branches.