docfy check
Verifica que cada controller está totalmente documentado antes do merge. Sai com código 1 se qualquer drift for detectado, pensado para CI.
Uso
bash
npx nestjs-docfy check [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 |
--quiet | false | Suppress all output except errors |
O que verifica
- Controllers com métodos HTTP mas sem companion docs file
- Controllers que ganharam métodos desde o último
generate
Exemplo de output
text
✖ UsersController, undocumented methods: updateProfile, deleteAccount
→ run nestjs-docfy generate --force to merge new methods
✖ 2 controller(s) out of sync.Integração com CI
.github/workflows/*.yml
# GitHub Actions example
- name: Check docs are up to date
run: npx nestjs-docfy checkOu como npm script:
json
{
"scripts": {
"docs:check": "nestjs-docfy check"
}
}