docfy check

Verifica que cada controller esté completamente documentado antes del merge. Sale con código 1 si detecta cualquier drift, pensado para CI.

Uso

bash
npx nestjs-docfy check [options]

Opciones

OptionDefaultDescription
--root <path>.Project root directory
--tsconfig <path>auto-detectedPath to tsconfig.json
--pattern <glob>**/*.controller.tsGlob pattern to find controllers
--format <format>tsFormato de docs file a buscar: ts o js
--jsonfalseImprime un único objeto JSON en vez de texto formateado: { controllersChecked, issues, docfyUiPin, versionDrift, passed }. Usado por el bot de PR pr-check.yml para parsear resultados en vez de raspar la salida de terminal.
--quietfalseSuppress all output except errors

Qué comprueba

  • Controllers con métodos HTTP pero sin docs file companion
  • Controllers que ganaron métodos desde el último generate
  • Docs files generados por una versión de nestjs-docfy más antigua que la instalada (informativo, ejecuta generate --overwrite para actualizar)

Salida de ejemplo

text
✖ UsersController, undocumented methods: updateProfile, deleteAccount
  → run nestjs-docfy generate --force to merge new methods

✖ 2 controller(s) out of sync.

Integración con CI

.github/workflows/*.yml
# GitHub Actions example
- name: Check docs are up to date
  run: npx nestjs-docfy check

O como npm script:

json
{
  "scripts": {
    "docs:check": "nestjs-docfy check"
  }
}