docfy check

Vérifie que chaque contrôleur est entièrement documenté avant de merger. Sort avec le code 1 si une dérive est détectée, pensé pour la CI.

Usage

bash
npx nestjs-docfy check [options]

Options

OptionDefaultDescription
--root <path>.Project root directory
--tsconfig <path>auto-detectedPath to tsconfig.json
--pattern <glob>**/*.controller.tsGlob pattern to find controllers
--format <format>tsFormat de fichier docs à rechercher : ts ou js
--jsonfalseProduit un seul objet JSON au lieu d'un texte formaté : { controllersChecked, issues, docfyUiPin, versionDrift, passed }. Utilisé par le bot pr-check.yml pour parser les résultats au lieu d'extraire la sortie terminal.
--quietfalseSuppress all output except errors

Ce qui est vérifié

  • Contrôleurs avec des méthodes HTTP mais sans fichier docs compagnon
  • Contrôleurs qui ont gagné des méthodes depuis le dernier generate
  • Fichiers docs générés par une version de nestjs-docfy plus ancienne que celle installée (informatif, lance generate --overwrite pour les rafraîchir)

Exemple de sortie

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

✖ 2 controller(s) out of sync.

Intégration CI

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

Ou comme script npm :

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