docfy check

Verifieert dat elke controller volledig gedocumenteerd is vóór het mergen. Sluit af met code 1 zodra drift wordt gedetecteerd, gebouwd voor CI.

Gebruik

bash
npx nestjs-docfy check [options]

Opties

OptionDefaultDescription
--root <path>.Project root directory
--tsconfig <path>auto-detectedPath to tsconfig.json
--pattern <glob>**/*.controller.tsGlob pattern to find controllers
--format <format>tsDocsbestandsformaat om naar te zoeken: ts of js
--jsonfalseGeeft één JSON-object terug in plaats van opgemaakte tekst: { controllersChecked, issues, docfyUiPin, versionDrift, passed }. Wordt gebruikt door de pr-check.yml PR-bot om resultaten te parsen in plaats van terminaloutput te scrapen.
--quietfalseSuppress all output except errors

Wat er gecontroleerd wordt

  • Controllers met HTTP-methoden maar zonder companion-docsbestand
  • Controllers die methoden hebben gekregen sinds de laatste generate
  • Docsbestanden gestempeld door een oudere nestjs-docfy-versie dan de geïnstalleerde (informatief, draai generate --overwrite om te verversen)

Voorbeelduitvoer

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

✖ 2 controller(s) out of sync.

CI-integratie

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

Of als npm-script:

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