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 方法但没有 companion 文件的控制器
  • 自上次 generate 以来新增了方法的控制器
  • docs 文件由比当前安装版本更旧的 nestjs-docfy 生成（仅提示性信息，运行 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 script：

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