docfy lint

Comprueba la calidad de la documentación, no solo su presencia. Detecta decorators ApiOperation, ApiResponse y ApiBody incompletos que check y coverage no señalarían.

Uso

bash
npx nestjs-docfy lint [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
--quietfalseSuppress all output except errors

Qué comprueba

Para cada método ya presente en un docs file:

  • ApiOperation sin summary
  • Endpoints con un parámetro @Body() sin un ApiResponse 400
  • Endpoints con un parámetro @Body() sin description en ApiBody

Los controllers sin docs file companion, o métodos que aún no están documentados en absoluto, quedan para check; lint solo juzga la calidad de lo que ya existe.

Salida de ejemplo

text
✖ POST /users
  Missing 400 response

✖ GET /users
  Missing operation summary

✖ PATCH /users/:id
  Missing request body description

✖ 3 issue(s) found.

Sale con código 1 si encuentra cualquier problema, pensado para CI, igual que check.

.github/workflows/*.yml
# GitHub Actions example
- name: Lint documentation quality
  run: npx nestjs-docfy lint