docfy check

マージ前にすべてのコントローラーが完全にドキュメント化されているか検証します。差分が検出されるとコード1で終了します。CI向けに設計されています。

使い方

bash
npx nestjs-docfy check [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
--jsonfalse整形されたテキストではなく、単一のJSONオブジェクトを出力します: { controllersChecked, issues, docfyUiPin, versionDrift, passed }。ターミナル出力をスクレイピングする代わりにpr-check.ymlのPRボットが結果をパースするために使用します。
--quietfalseSuppress all output except errors

チェック内容

  • HTTPメソッドを持つがコンパニオンdocsファイルを持たないコントローラー
  • 前回のgenerate以降にメソッドが増えたコントローラー
  • インストール済みのバージョンより古いnestjs-docfyバージョンでスタンプされたdocsファイル(情報提供のみ。更新するにはgenerate --overwriteを実行してください)

出力例

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

✖ 2 controller(s) out of sync.

CI統合

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

またはnpmスクリプトとして:

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