docfy lint

Vérifie la qualité de la documentation, pas juste sa présence. Repère les décorateurs ApiOperation, ApiResponse et ApiBody incomplets que check et coverage ne signaleraient pas.

Usage

bash
npx nestjs-docfy lint [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
--quietfalseSuppress all output except errors

Ce qui est vérifié

Pour chaque méthode déjà présente dans un fichier docs :

  • ApiOperation sans summary
  • Endpoints avec un paramètre @Body() sans ApiResponse 400
  • Endpoints avec un paramètre @Body() sans description sur ApiBody

Les contrôleurs sans fichier docs compagnon, ou les méthodes pas encore documentées du tout, sont laissés à check ; lint ne juge que la qualité de ce qui est déjà là.

Exemple de sortie

text
✖ POST /users
  Missing 400 response

✖ GET /users
  Missing operation summary

✖ PATCH /users/:id
  Missing request body description

✖ 3 issue(s) found.

Sort avec le code 1 si un problème est trouvé, pensé pour la CI, comme check.

.github/workflows/*.yml
# GitHub Actions example
- name: Lint documentation quality
  run: npx nestjs-docfy lint