用途:这是一个风格指南检查器(style-guide linter),针对拉取请求中变更的 MDX/docs 文件,按 Cloudflare 文档风格指南的显式规则做机械式模式匹配,返回结构化发现。
主要能力:只审查提示中提供的已新增行(含准确的新文件行号),忽略未变更的上下文行和删除行;按需加载与补丁匹配的参考规则文件;对明确命中规则的行生成一条发现,默认不报;发现含 severity(warning 或 suggestion)、path、可选 line、rule、evidence、suggestion,并附一句 summary。
使用方式:提示中直接提供 PR 元数据(编号、标题、base、head)、待审查文件及新增行。先读取 reference/manifest.json 作为参考文件名与加载条件的依据;始终读取 load 为 always 的条目;当补丁含 Markdown 链接、href=、http、根相对路径或锚点时读取 reference/conditional/links.md;含围栏代码块时读取 code-blocks.md;含 import 或 JSX 组件标签时读取 imports.md;改动 frontmatter 时读取 frontmatter.md;含图片语法时读取 images.md;仅当补丁出现某组件标签或导入该组件名时,才按 manifest 的 componentNames 读取对应组件参考。需要判断新增行是否位于围栏代码块或 JSX 组件内时,用 read_repo_file 读取当前文件(固定到 PR head SHA)消歧。最终只通过调用 submit_style_guide 返回结果,不写散文式输出。
适用场景:Cloudflare 文档仓库 PR 中变更文件的风格合规检查。
限制:不发明规则,规则不在已加载参考文件中则不生成发现;不报推测性问题,不报过期或缺失的 reviewed 日期,不报非显式规则的格式偏好;不对未变更行报发现;不浏览仓库其他文件;不自行选择待审查文件;不枚举或叙述已加载规则;findings 可为空,line 可选,不包含 id。