docfy lint

Checa qualidade da documentação, não só presença. Pega ApiOperation, ApiResponse e ApiBody incompletos que check e coverage não sinalizariam.

Uso

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>tsDocs file format to look for: ts ou js
--quietfalseSuppress all output except errors

O que verifica

Para cada método já presente em um docs file:

  • ApiOperation sem summary
  • Endpoints com parâmetro @Body() sem ApiResponse 400
  • Endpoints com parâmetro @Body() sem description no ApiBody

Controllers sem companion docs file, ou métodos ainda não documentados, são deixados para o check; lint só julga a qualidade do que já está lá.

Exemplo de output

text
✖ POST /users
  Missing 400 response

✖ GET /users
  Missing operation summary

✖ PATCH /users/:id
  Missing request body description

✖ 3 issue(s) found.

Sai com código 1 se qualquer issue for encontrada, pensado para CI, igual ao check.

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