docfy coverage
Mede que percentual dos seus endpoints está documentado. Útil como métrica objetiva de qualidade e como gate de CI.
Uso
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 | Docs file format to look for: ts ou js |
--min <percent> | none | Minimum coverage required (0-100), exits 1 if below |
--json | false | Imprime um único objeto JSON em vez de texto formatado: o relatório de coverage mais min e passed. |
--quiet | false | Suppress all output except errors |
Exemplo de output
text
Controllers: 42
Endpoints: 187
Documented: 174
Missing docs: 13
Coverage: 93.0%Enforcing um mínimo em CI
bash
npx nestjs-docfy coverage --min 95Quando a coverage cai abaixo de --min, o comando sai com código 1, quebrando o build.
.github/workflows/*.yml
# GitHub Actions example
- name: Enforce documentation coverage
run: npx nestjs-docfy coverage --min 95Ou como npm script:
json
{
"scripts": {
"docs:coverage": "nestjs-docfy coverage --min 95"
}
}Bot de PR
O próprio .github/workflows/pr-check.yml do nest-docfy é um exemplo real: roda check --json e coverage --json --min contra um projeto em cada PR e posta (atualizando, nunca spamando) um único comentário de resumo, construído inteiramente sobre output --json e fetch nativo contra a REST API do GitHub, sem dependências extras.