docfy coverage
Misura la percentuale di endpoint documentati. Utile come metrica oggettiva di qualità e come gate CI.
Utilizzo
bash
npx nestjs-docfy coverage [options]Opzioni
| Option | Default | Description |
|---|---|---|
--root <path> | . | Project root directory |
--tsconfig <path> | auto-detected | Path to tsconfig.json |
--pattern <glob> | **/*.controller.ts | Glob pattern to find controllers |
--format <format> | ts | Formato del file docs da cercare: ts o js |
--min <percent> | none | Copertura minima richiesta (0-100), esce con 1 se sotto soglia |
--json | false | Restituisce un singolo oggetto JSON invece di testo formattato: il report di copertura più min e passed. |
--quiet | false | Suppress all output except errors |
Esempio di output
text
Controllers: 42
Endpoints: 187
Documented: 174
Missing docs: 13
Coverage: 93.0%Imporre un minimo in CI
bash
npx nestjs-docfy coverage --min 95Quando la copertura scende sotto --min, il comando esce con codice 1, facendo fallire la build.
.github/workflows/*.yml
# GitHub Actions example
- name: Enforce documentation coverage
run: npx nestjs-docfy coverage --min 95Oppure come script npm:
json
{
"scripts": {
"docs:coverage": "nestjs-docfy coverage --min 95"
}
}Bot PR
Il workflow .github/workflows/pr-check.yml di nest-docfy stesso è un esempio reale: esegue check --json e coverage --json --min su un progetto a ogni PR e pubblica (aggiornandolo, senza mai spammare) un unico commento di riepilogo, costruito interamente sull'output --json e sul fetch nativo contro la REST API di GitHub, senza dipendenze aggiuntive.