docfy check

Sprawdza, czy każdy kontroler jest w pełni udokumentowany przed scaleniem. Kończy się kodem 1, jeśli wykryto rozbieżność, przeznaczone do CI.

Użycie

bash
npx nestjs-docfy check [options]

Opcje

OptionDefaultDescription
--root <path>.Project root directory
--tsconfig <path>auto-detectedPath to tsconfig.json
--pattern <glob>**/*.controller.tsGlob pattern to find controllers
--format <format>tsFormat pliku docs do wyszukania: ts albo js
--jsonfalseZwraca pojedynczy obiekt JSON zamiast sformatowanego tekstu: { controllersChecked, issues, docfyUiPin, versionDrift, passed }. Używane przez bota PR z pr-check.yml do parsowania wyników zamiast zdrapywania wyjścia terminala.
--quietfalseSuppress all output except errors

Co sprawdza

  • Kontrolery z metodami HTTP bez pliku docs towarzyszącego
  • Kontrolery, które zyskały metody od ostatniego generate
  • Pliki docs oznaczone starszą wersją nestjs-docfy niż zainstalowana (informacyjne, uruchom generate --overwrite, aby odświeżyć)

Przykładowy wynik

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

✖ 2 controller(s) out of sync.

Integracja z CI

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

Albo jako skrypt npm:

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