AI Pulse
📡 X 信号

Claude Code 实用技巧:让 Opus 5.5 生成可点击代码仓库地图

Claude Code 实用技巧:让 Opus 5.5 生成可点击代码仓库地图

Claude Code 有个实用技巧:让 Opus 5.5 为你的代码仓库生成可点击的地图,再标出所有「你平时对模块的称呼和代码里实际命名不一致」的位置。

点击任意模块,就能看到它的调用方、依赖关系、核心流程、相关测试、源码依据,以及团队平时对这个模块的常用叫法。运行后会在 docs/codemap/ 目录下生成三个文件:codemap.html(可直接在浏览器打开的交互式地图)、codemap.json(结构化数据)、codemap.lock(版本校验文件)。

把下面这段完整提示词粘贴到 Claude Code 里就能直接运行:

分析当前代码库,不要修改产品代码,只在 docs/codemap/ 目录下创建或更新文件。忽略 vendor、build、dist、缓存等自动生成的目录。如果 docs/codemap/ 已经存在,先对比已有的 codemap.lock 和当前仓库,列出发生变化的模块,再重新生成三个文件。

第一个文件 codemap.html 是完全自包含的交互式代码地图,默认深色主题,首屏就能看到系统边界和核心数据流。最多展示 20 个核心节点,底层文件归入所属父模块,不同类型的模块用颜色区分并附带图例。点击任意模块会高亮它的上游调用方、下游依赖、相关测试和所属流程,同时显示团队对它的常用称呼;选中某个流程会高亮它的完整路径。页面支持搜索、过滤、缩放和拖拽操作。

每个模块旁边都会标注团队对它的常用称呼,和代码里实际命名不一致的地方会标红。页面顶部有「用语与命名对比」面板,左边是团队的常用叫法,右边是代码里的实际名称和路径,最容易导致误改的不一致项排在最前面。页面顶部还会显示仓库名、生成时间和对应的提交哈希。

第二个文件 codemap.json 采用固定结构,包含生成时间、对应提交、扫描范围、节点、边、流程、不一致项七个部分。每个节点要记录路径、角色、入口、测试、约束、源码依据,以及团队对它的别名和别名来源(README、文档、UI 文本、路由、issue 和提交标题)。每条边要记录起点、终点和关系类型,关系类型只能是导入、调用、读、写、发布、订阅五种。每个流程要记录触发条件、步骤和结果,每一步都要对应已有的节点。每个不一致项要记录团队叫法、代码实际名称、路径,以及建议修改哪一侧。

所有节点和边都要附带对应的源码路径和符号,没有源码依据的关系标记为未知,不要猜测。不要修改代码或现有文档。

第三个文件 codemap.lock 用可解析的 JSON 记录当前提交、工作区是否有未提交修改、生成时间、扫描范围、排除目录、指纹算法,以及每个顶层模块的确定性指纹(基于跟踪的文件路径和当前内容计算)。如果没有找到已有的 codemap.lock,就把所有模块当作新模块,生成完整地图。

生成完成后要自动校验:codemap.json 能正常解析,所有节点路径存在、所有依据符号能在源码中找到,所有边和流程步骤都对应已存在的节点,codemap.html 和 codemap.json 使用完全相同的节点、边和流程,codemap.lock 和当前提交、工作区状态、模块指纹匹配,没有源码依据的关系都标记为未知,所有别名都能在对应来源中找到,找不到的标记为未知,不要编造。

三个文件必须始终基于当前仓库一起生成,不要手动单独修改其中某一个。运行结束后会展示:创建或修改的文件、过时的模块、剩余的未知项、按混淆程度排序的不一致项、校验结果和完整 diff。

查看 X 原帖

订阅 AI Pulse

每天 08:00 · 12:30 · 18:30 · 23:50 更新