docfy lint

Sprawdza jakość dokumentacji, nie tylko jej obecność. Wychwytuje niekompletne dekoratory ApiOperation, ApiResponse i ApiBody, których check i coverage by nie zgłosiły.

Użycie

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

Co sprawdza

Dla każdej metody już obecnej w pliku docs:

  • ApiOperation bez summary
  • Endpointy z parametrem @Body() bez odpowiedzi ApiResponse 400
  • Endpointy z parametrem @Body() bez opisu ApiBody description

Kontrolery bez towarzyszącego pliku docs, albo metody jeszcze w ogóle nieudokumentowane, są pozostawione komendzie check; lint ocenia wyłącznie jakość tego, co już tam jest.

Przykładowy wynik

text
✖ POST /users
  Missing 400 response

✖ GET /users
  Missing operation summary

✖ PATCH /users/:id
  Missing request body description

✖ 3 issue(s) found.

Kończy się kodem 1, jeśli znaleziono jakikolwiek problem, przeznaczone do CI, tak samo jak check.

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