docfy coverage

Misst, wie viel Prozent deiner Endpunkte dokumentiert sind. Nützlich als objektive Qualitätsmetrik und als CI-Gate.

Verwendung

bash
npx nestjs-docfy coverage [options]

Optionen

OptionDefaultDescription
--root <path>.Project root directory
--tsconfig <path>auto-detectedPath to tsconfig.json
--pattern <glob>**/*.controller.tsGlob pattern to find controllers
--format <format>tsZu suchendes Docs-Dateiformat: ts oder js
--min <percent>noneMinimal erforderliche Coverage (0–100), beendet sich mit 1, falls darunter
--jsonfalseGibt ein einzelnes JSON-Objekt statt formatiertem Text aus: den Coverage-Report plus min und passed.
--quietfalseSuppress all output except errors

Beispielausgabe

text
Controllers: 42
Endpoints: 187

Documented: 174
Missing docs: 13

Coverage: 93.0%

Ein Minimum in CI erzwingen

bash
npx nestjs-docfy coverage --min 95

Fällt die Coverage unter --min, beendet sich der Befehl mit Code 1 und lässt den Build fehlschlagen.

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

Oder als npm-Script:

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

PR-Bot

Der eigene .github/workflows/pr-check.yml von nest-docfy ist ein reales Beispiel: Er führt bei jedem PR check --json und coverage --json --min gegen ein Projekt aus und postet einen einzigen, aktualisierten Zusammenfassungskommentar (statt zu spammen) – vollständig auf Basis von --json-Ausgabe und nativem fetch gegen die GitHub-REST-API, ganz ohne zusätzliche Abhängigkeiten.