SuperAPI AI 工具集

repo-map

编程与开发

查看项目

更新于 10-29 13:22

技能介绍

用途:repo-map 用于为一组并排克隆的仓库建立“活地图”,集中说明每个仓库负责什么、包含哪些 Django 应用和模型、对外暴露和消费哪些 API、共享哪些数据库、有哪些后台任务,以及仓库之间通过何种方式相互调用。常见使用场景是多仓库项目需要做影响分析、跨仓库改动、编写 PRD 或拆分 Jira 工单时,先查阅这份地图。

主要能力:构建模式会列出工作区内所有 git 仓库;若某些客户端仓库未在本地克隆,只标注“未克隆”而不做猜测。对每个仓库读取 README、依赖文件(requirements*.txt、pyproject.toml、package.json)、settings*.py、根 urls.py、docker-compose*.yml、CI 配置和部署配置。对 Django 仓库,提取 INSTALLED_APPS 中的本地应用及各应用的单行模型说明、各应用的 URL 前缀、Celery 任务与 beat 计划、按 cron 运行的管理命令、对其他服务的出站调用及其基址环境变量。随后整理仓库间连接关系(HTTP 端点、共享数据库、队列、Webhook、共享包),特别标出共享数据库表这一最危险的联系。还会阅读 2 至 3 个代表性应用,记录实际编码约定,如视图风格、路由与 URL 命名、权限与查询集作用域、业务逻辑位置、序列化与校验、错误格式、测试框架与工厂用法、配置拆分与环境变量读取方式、异步任务写法,并各附一个示例文件路径。

使用方式:产物位置有两种约定——多个仓库并排克隆时,放在承载它们的父目录下的 repo-map.md,并同时提交一份到主后端仓库的 docs/repo-map.md;单仓库时放在 docs/repo-map.md。地图按固定模板组织,包含仓库总表、各仓库的应用与模型、API 前缀、后台任务、出站调用、Mermaid 连接图及连接契约表、团队约定章节,并记录“最后刷新日期”和各仓库的 commit sha。刷新模式读取上次记录的 sha,用 git log --oneline <sha>..HEAD --stat 找出变更,只重读被提交触及的新应用、新模型、URL 变化、新出站调用和新任务,更新对应章节、更新日期与 sha,并在回复顶部列出变更内容。

限制与要求:地图中每条信息都必须可核查,指向具体文件;不得把猜测写成事实,未知项标注未验证;不得写入密钥、生产数据库主机名或凭据,只能写环境变量名;当代码与 README 冲突时以代码为准并记录该冲突;地图应保持简洁,约 300 行以内,用链接指向文件而非复制代码。