agentleFS
petarzarkovpetarzarkov/dunx/.claude/skills/coverage-report/SKILL.md

coverage-report

Skill93 starsChanged 4 months agoMITView on GitHub

Regenerate the coverage report and badges, or diagnose a wrong percentage, a 404ing badge, or a package showing 0%. Use after adding a package, when coverage numbers look implausible, or when the published coverage site is stale or broken.

2 other projects use a version of this.

Adopted by

Most recently taken up by

  • Other versions2 projects use a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 2

    1. Eleven-M/flowmind★ 1same name
    2. osac-project/osac-ai-skills★ 0same name

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • In this repository6 other files it gives its agents.

The file

Files
SKILL.md

/coverage-report

bun run test:cov      # bun test --coverage from the ROOT, then gen:cov
bun run docs:build    # the site is what carries the report and the badges
bun run gen:readme    # only if the package set changed

Order matters. test:cov must run once from the repo root so every package lands in a single coverage/lcov.info; running it per package overwrites that file with one package's data.

scripts/coverage-report.ts then turns the lcov into two things, both inside internal/docs - the site is the Pages root, coverage is a page in it:

  • internal/docs/src/generated/coverage.json - the model the Coverage page renders (per-package breakdown, uncovered line ranges, packages with no tests)
  • internal/docs/public/badges/coverage.svg plus a coverage-<package>.svg each, which the build copies verbatim to /badges/ in the built site

Zero dependencies. It writes no HTML of its own any more; bun run docs:build has to run afterwards for either output to reach the deployed site. CI does that in the Build the documentation site step, which sits after test:cov for exactly this reason.

Badges live in the root README's generated Packages table, in the Coverage column added by scripts/update-readme.ts - not in per-package READMEs. A new package picks one up automatically on the next gen:cov + gen:readme.

Lines and functions only. Bun emits no branch records, so there is no branch column to add.

Diagnosing

SymptomCause
Every badge 404s on GitHubPages is on the default Deploy from a branch source, so GitHub serves a Jekyll render of the README. It must be set to GitHub Actions in repo settings.
One package's number is way offA sibling import resolved to that sibling's dist/ and got counted alongside its src/. bunfig.toml sets coveragePathIgnorePatterns = ["**/dist/**"] - check it holds.
Package shows grey no testsCorrect, not a bug - no test files. Grey beats a misleading 0%.
Numbers stale after adding testsgen:cov ran without a fresh test:cov, so it reparsed the old lcov.
New package missing from the tablegen:readme not run after gen:cov.
Coverage page says "no coverage data"The site was built before gen:cov ran. bun run test:cov && bun run docs:build.
Badges 404 but the site loadsThey are at /badges/coverage-<pkg>.svg now, not the Pages root. Check scripts/update-readme.ts's DOCS_SITE.

ci.yml publishes internal/docs/dist/ to Pages from a separate pages job on main: https://dunx.win, with the report at https://dunx.win/coverage.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.