用途:sync-docs 用于恢复文档与代码一致的不变量,即让公开文档、示例、版本号和变更日志准确描述当前代码。它从 git diff 出发,将改动代码映射到耦合的 Markdown,只应用安全子集,并附证据标记全部语义漂移。
主要能力:支持 report(默认)与 apply 两种模式,apply 仍只改安全项;范围支持 recent(当前分支或最近提交改动)、before-pr(对 PR base 的分支 diff)、all(扫描全部跟踪的代码与文档)。它提取文件名、路径、import 字符串、导出符号等耦合词,在 README.md、CHANGELOG.md、docs/**/*.md 等现有文档面搜索并按 filename、full-path、import、symbol、url-path、version 记录引用。问题按 HIGH/MEDIUM/LOW 分级,仅自动处理两类安全修正:文档中明确标注的过期 semver 版本号替换为 manifest 版本;在 ## [Unreleased] 下插入最小变更条目。
使用方式:先确定 scope 与 base,base 优先显式指定,否则解析默认分支,官方示例命令包括:git diff --name-status "origin/$base"...HEAD、git diff --name-status HEAD~5..HEAD、git ls-files。生成代码改动清单(含 status、oldPath、path、basename、modulePath、kind),再搜索耦合词、分类问题、应用安全修正并输出修复台账与标记报告。有代码图索引时优先使用 codegraph_search、codegraph_callers、codegraph_callees、codegraph_impact、codegraph_files;无索引时可用 git grep、ast-grep 回退。
适用场景:分支改动公共 API、导入、CLI 标志、配置名、包版本、导出符号、示例或用户可见行为,而文档可能滞后时。
限制:不适用于生成文档刷新、大规模文案重写、API 设计评审、从零撰写发布说明、或来源在外部的情况;此时只报告漂移信号而不编辑。移除的导出、导入路径、示例、未文档化导出、死代码文档和零耦合的文档漂移均只标记,需人工确认意图。输入、输出契约、验证门及分类依据见官方页面;价格、平台支持等资料暂未提供。