docfy coverage
Mesure le pourcentage de tes endpoints documentés. Utile comme métrique de qualité objective et comme garde-fou en CI.
Usage
bash
npx nestjs-docfy coverage [options]Options
| 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 | Format de fichier docs à rechercher : ts ou js |
--min <percent> | none | Couverture minimale requise (0-100), sort avec 1 si en dessous |
--json | false | Produit un seul objet JSON au lieu d'un texte formaté : le rapport de couverture plus min et passed. |
--quiet | false | Suppress all output except errors |
Exemple de sortie
text
Controllers: 42
Endpoints: 187
Documented: 174
Missing docs: 13
Coverage: 93.0%Imposer un minimum en CI
bash
npx nestjs-docfy coverage --min 95Quand la couverture tombe sous --min, la commande sort avec le code 1, faisant échouer le build.
.github/workflows/*.yml
# GitHub Actions example
- name: Enforce documentation coverage
run: npx nestjs-docfy coverage --min 95Ou comme script npm :
json
{
"scripts": {
"docs:coverage": "nestjs-docfy coverage --min 95"
}
}Bot de PR
Le propre .github/workflows/pr-check.yml de nest-docfy en est un exemple concret : il lance check --json et coverage --json --min sur le projet à chaque PR et poste (en mettant à jour, jamais en spammant) un seul commentaire de résumé, construit entièrement sur la sortie --json et un fetch natif vers l'API REST de GitHub, sans dépendance supplémentaire.