docfy coverage

Meet welk percentage van je endpoints gedocumenteerd is. Handig als objectieve kwaliteitsmetriek en als CI-gate.

Gebruik

bash
npx nestjs-docfy coverage [options]

Opties

OptionDefaultDescription
--root <path>.Project root directory
--tsconfig <path>auto-detectedPath to tsconfig.json
--pattern <glob>**/*.controller.tsGlob pattern to find controllers
--format <format>tsDocsbestandsformaat om naar te zoeken: ts of js
--min <percent>noneMinimaal vereiste coverage (0-100), sluit af met 1 als eronder gescoord wordt
--jsonfalseGeeft één JSON-object terug in plaats van opgemaakte tekst: het coverage-rapport plus min en passed.
--quietfalseSuppress all output except errors

Voorbeelduitvoer

text
Controllers: 42
Endpoints: 187

Documented: 174
Missing docs: 13

Coverage: 93.0%

Een minimum afdwingen in CI

bash
npx nestjs-docfy coverage --min 95

Zakt de coverage onder --min, dan sluit het commando af met code 1, wat de build laat falen.

.github/workflows/*.yml
# GitHub Actions example
- name: Enforce documentation coverage
  run: npx nestjs-docfy coverage --min 95

Of als npm-script:

json
{
  "scripts": {
    "docs:coverage": "nestjs-docfy coverage --min 95"
  }
}

PR-bot

De eigen .github/workflows/pr-check.yml van nest-docfy is een echt voorbeeld: die draait check --json en coverage --json --min tegen een project bij elke PR en plaatst (bijwerkend, nooit spammend) één samenvattend commentaar, volledig gebouwd op --json-output en native fetch tegen de GitHub REST API, zonder extra dependencies.