docfy coverage
Mide qué porcentaje de tus endpoints está documentado. Útil como métrica objetiva de calidad y como gate de CI.
Uso
bash
npx nestjs-docfy coverage [options]Opciones
| 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 de docs file a buscar: ts o js |
--min <percent> | none | Cobertura mínima requerida (0-100), sale con 1 si está por debajo |
--json | false | Imprime un único objeto JSON en vez de texto formateado: el reporte de cobertura más min y passed. |
--quiet | false | Suppress all output except errors |
Salida de ejemplo
text
Controllers: 42
Endpoints: 187
Documented: 174
Missing docs: 13
Coverage: 93.0%Exigiendo un mínimo en CI
bash
npx nestjs-docfy coverage --min 95Cuando la cobertura cae por debajo de --min, el comando sale con código 1, fallando el build.
.github/workflows/*.yml
# GitHub Actions example
- name: Enforce documentation coverage
run: npx nestjs-docfy coverage --min 95O como npm script:
json
{
"scripts": {
"docs:coverage": "nestjs-docfy coverage --min 95"
}
}Bot de PR
El propio .github/workflows/pr-check.yml de nest-docfy es un ejemplo real: ejecuta check --json y coverage --json --min contra un proyecto en cada PR y publica (actualizando, nunca haciendo spam) un único comentario resumen, construido enteramente sobre la salida de --json y fetch nativo contra la API REST de GitHub, sin dependencias extra.