SuperAPI AI 工具集

codebase-mapper

编程与开发

查看项目

更新于 10-23 16:17

技能介绍

codebase-mapper 是一个面向已有代码库的分析型智能体,属于 GSD Codebase Mapper Agent,核心目标是在不改变代码的前提下,快速建立对项目结构、技术选型与遗留问题的整体认识,并输出可长期维护的文档。

主要能力分为五个分析域。结构分析:识别源码目录及用途、入口文件(主文件与 index 文件)、测试位置与写法、配置文件位置、资源目录。依赖分析:整理运行时(生产)依赖、开发依赖、对等依赖,并检查过时包与安全漏洞。模式分析:归纳命名约定、文件组织方式、错误处理思路、状态管理模式与 API 写法。集成分析:梳理调用的外部 API、使用的数据库、第三方服务与环境变量依赖。技术债分析:检索 TODO、FIXME、HACK、XXX 标记,已弃用代码、缺失测试、不一致模式与已知漏洞。

使用方式上,智能体先通过项目标记文件判断类型,例如用 package.json、requirements.txt 或 pyproject.toml、Cargo.toml、go.mod、*.csproj 等文件识别 Node.js/JavaScript、Python、Rust、Go、.NET 项目;随后按阶段扫描目录结构(排除 node_modules、.git、pycache、dist、build、.next 等)、提取各生态依赖、搜索常见模式(组件文件、API 路由、interface/type/schema 定义),并检索债务标记。资料中的扫描命令以 PowerShell 编写,需在具备对应环境与权限的终端中运行。

输出方面,它会生成两份文档。ARCHITECTURE.md 包含系统概述、系统图(ASCII 或组件关系描述)、各组件的目的/位置/依赖/被依赖方、数据流、集成点表格、约定(命名、结构、测试)以及技术债清单。STACK.md 包含运行时、生产依赖、开发依赖、基础设施、配置变量等表格,记录技术与版本及用途。完成前还有一份检查清单,确认项目类型已识别、源码目录已记录、入口点已找到、依赖已分类、关键模式已识别、集成已梳理、技术债已呈现,并且两份文档均已创建。

适用场景包括:接手陌生仓库时快速建立认知、为项目补充架构与栈文档、在重构或升级前评估技术债与依赖状况。限制方面,资料未说明其支持的项目类型是否覆盖上述之外的语言生态,也未说明扫描的规模上限、是否需要网络访问、如何处理敏感信息;具体的安装与调用方式除 /map 命令与扫描脚本外暂未提供。