docfy check

Prüft, ob jeder Controller vollständig dokumentiert ist, bevor gemerged wird. Beendet sich mit Code 1, wenn Drift erkannt wird – gedacht für CI.

Verwendung

bash
npx nestjs-docfy check [options]

Optionen

OptionDefaultDescription
--root <path>.Project root directory
--tsconfig <path>auto-detectedPath to tsconfig.json
--pattern <glob>**/*.controller.tsGlob pattern to find controllers
--format <format>tsZu suchendes Docs-Dateiformat: ts oder js
--jsonfalseGibt ein einzelnes JSON-Objekt statt formatiertem Text aus: { controllersChecked, issues, docfyUiPin, versionDrift, passed }. Wird vom PR-Bot pr-check.yml genutzt, um Ergebnisse zu parsen, statt Terminal-Ausgabe zu scrapen.
--quietfalseSuppress all output except errors

Was geprüft wird

  • Controller mit HTTP-Methoden, aber ohne Companion-Docs-Datei
  • Controller, die seit dem letzten generate neue Methoden bekommen haben
  • Docs-Dateien, die mit einer älteren nestjs-docfy-Version gestempelt sind als der installierten (informativ, mit generate --overwrite auffrischen)

Beispielausgabe

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

✖ 2 controller(s) out of sync.

CI-Integration

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

Oder als npm-Script:

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