docfy lint

存在の有無だけでなく、ドキュメントの品質を検査します。checkやcoverageでは検出できない、不完全なApiOperation、ApiResponse、ApiBodyデコレーターを検出します。

使い方

bash
npx nestjs-docfy lint [options]

オプション

OptionDefaultDescription
--root <path>.Project root directory
--tsconfig <path>auto-detectedPath to tsconfig.json
--pattern <glob>**/*.controller.tsGlob pattern to find controllers
--format <format>ts探索するdocsファイルの形式: tsまたはjs
--quietfalseSuppress all output except errors

チェック内容

docsファイルにすでに存在する各メソッドについて:

  • summaryが欠けているApiOperation
  • @Body()パラメータを持つがApiResponse 400が欠けているエンドポイント
  • @Body()パラメータを持つがApiBody descriptionが欠けているエンドポイント

コンパニオンdocsファイルを持たないコントローラーや、まだドキュメント化されていないメソッドの判定はcheckに任せます。lintはすでに存在するものの品質だけを判定します。

出力例

text
✖ POST /users
  Missing 400 response

✖ GET /users
  Missing operation summary

✖ PATCH /users/:id
  Missing request body description

✖ 3 issue(s) found.

問題が見つかった場合はコード1で終了します。checkと同様、CI向けに設計されています。

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