docfy lint

Controlla la qualità della documentazione, non solo la sua presenza. Rileva decorator ApiOperation, ApiResponse e ApiBody incompleti che check e coverage non segnalerebbero.

Utilizzo

bash
npx nestjs-docfy lint [options]

Opzioni

OptionDefaultDescription
--root <path>.Project root directory
--tsconfig <path>auto-detectedPath to tsconfig.json
--pattern <glob>**/*.controller.tsGlob pattern to find controllers
--format <format>tsFormato del file docs da cercare: ts o js
--quietfalseSuppress all output except errors

Cosa controlla

Per ogni metodo già presente in un file docs:

  • ApiOperation privo di summary
  • Endpoint con parametro @Body() privi di una risposta ApiResponse 400
  • Endpoint con parametro @Body() privi di ApiBody con description

I controller senza un file docs companion, o i metodi non ancora documentati, sono lasciati a check; lint giudica solo la qualità di ciò che è già presente.

Esempio di output

text
✖ POST /users
  Missing 400 response

✖ GET /users
  Missing operation summary

✖ PATCH /users/:id
  Missing request body description

✖ 3 issue(s) found.

Esce con codice 1 se viene trovato un problema, pensato per la CI, come check.

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