SuperAPI AI 工具集

code-atlas

编程与开发

查看项目

更新于 10-16 08:39

技能介绍

用途:code-atlas 用于从代码事实出发构建可重复生成的架构图谱,把代码库变成可导航的地图层,帮助工程师仅凭图谱和缺陷报告即可追踪完整执行路径,而无需打开源码。

主要能力:覆盖 8 个图层(repo-surface、ast-lsp-bindings、compile-deps、runtime-topology、api-contracts、data-flow、service-components、user-journeys),默认同时输出 Graphviz DOT 与 Mermaid 两种图形,并渲染 SVG。内置三遍缺陷挖掘流程:Pass 1 构建并查找图层间矛盾,Pass 2 新上下文交叉复核,Pass 3 对用户旅程端到端追踪并给出 PASS/FAIL/NEEDS_ATTENTION。还提供基于 LAYERS.yaml 中 glob 模式的过期检测、图层密度管理(过密时按包或服务拆分为约 15-40 节点的子图)、以及发布到 GitHub Pages 与 mkdocs 的工作流。

使用方式:可用自然语言触发,例如“Build a complete code atlas for this repository”“Run code atlas bug hunting passes on this service”“Are our architecture diagrams still accurate?”“Publish our code atlas to GitHub Pages”;也可用“Build a code atlas using only Mermaid”指定单一格式。构建按 12 个阶段执行,从校验前置工具(mmdc、dot)与选择图后端开始,先构建 1-4 结构层,再构建 5-8 行为层,随后做三遍缺陷挖掘、多智能体验证并以 GitHub issue 登记。输出位于 docs/atlas/{slug}/,含 .mmd、.dot、-mermaid.svg、-dot.svg 与 README.md;docs/atlas/cypher/ 始终输出可移植 OpenCypher 图产物。图后端按 kuzu -> lbug -> neo4j -> portable-cypher-only 自动检测,可选值会记录在 index.md 与 staleness-map.yaml。

适用场景:接手不熟悉的代码库、新工程师入职导航、大型重构前测绘、缺陷排查停滞、文档过期检查、CI/CD 质量门禁、发布文档站点、评审不熟悉的 PR。

限制:不是静态分析工具,使用 grep、AST、配置解析而非编译器;过期检测为基于 git diff 模式匹配的启发式而非语义分析;compile-deps/service-components 分析按语言适配(python-ast、rust-cargo-metadata、static-approximation),Python 并非非 Python 仓库的必需条件;缺陷挖掘结果不存入图谱,而是以 code-atlas-bughunt 标签提交为 GitHub issue。具体模板、错误码与完整配置见 bug-hunt-guide.md、reference.md、publication-guide.md、examples.md、SECURITY.md、API-CONTRACTS.md,本次资料未提供这些文件的正文内容。