docfy check

Verifica che ogni controller sia completamente documentato prima del merge. Esce con codice 1 se viene rilevato uno scostamento, pensato per la CI.

Utilizzo

bash
npx nestjs-docfy check [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
--jsonfalseRestituisce un singolo oggetto JSON invece di testo formattato: { controllersChecked, issues, docfyUiPin, versionDrift, passed }. Usato dal bot PR pr-check.yml per fare il parsing dei risultati invece di leggere l'output del terminale.
--quietfalseSuppress all output except errors

Cosa controlla

  • Controller con metodi HTTP ma senza file docs companion
  • Controller a cui sono stati aggiunti metodi dall'ultimo generate
  • File docs generati da una versione di nestjs-docfy più vecchia di quella installata (informativo, esegui generate --overwrite per aggiornarli)

Esempio di output

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

✖ 2 controller(s) out of sync.

Integrazione CI

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

Oppure come script npm:

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