SuperAPI AI 工具集

pr-layer-map

编程与开发

查看项目

更新于 10-16 03:11

技能介绍

用途:为 FormSG 的 pull request 生成 Mermaid 分层图,展示改动触及哪些架构层(前端页面/UI/API 客户端、packages/shared、packages/sdk 等),输出为可直接粘贴进 GitHub PR 描述的 ```mermaid 代码块。

主要能力:脚本 classify_changes.py 支持按 PR 编号或 URL 分析,也支持当前分支与 merge-base 对比;--mermaid 输出完整图块,--no-counts 去掉 +N −M 标注,去掉 --mermaid 则输出底层 JSON 供查看逐文件细节。图中实心层表示有源码改动,描边层表示仅测试改动,灰色虚线层表示未触及;实线箭头为请求路径,点线为导入关系,粗箭头为前后端网络边界。改动局限在单一分组且不超过三层时自动压缩为单行链,并注明未触及部分;仅涉及 packages/shared 或 packages/sdk 的改动不压缩。

使用方式:在 FormSG 工作目录运行 python3 scripts/classify_changes.py --pr 9893 --mermaid,或 python3 scripts/classify_changes.py --branch --base main --mermaid。输出需原样粘贴,不要手写 Mermaid。

适用场景:PR 评审时快速判断改动范围、关注重点层、识别契约跨越(packages/sdk 被第三方表单所有者消费,改动会外溢到仓库之外)。

限制:节点集合、27 层到十节点的折叠及明暗样式均编码在脚本中;规则失效时应修改脚本内有序 RULES 列表而非改输出;未匹配任何规则的文件进入 unknown 桶,非空表示规则落后于仓库结构。references/layers.md 记录各层含义与歧义路径解析。官方未提供收费、平台支持等信息。