SuperAPI AI 工具集

gsd codebase mapper

编程与开发

查看项目

更新于 10-24 17:24

技能介绍

用途

GSD Codebase Mapper 是一个智能体技能,主要职责是分析现有代码库,帮助开发者理解项目结构、模式和技术债务。它最终产出两份文档:ARCHITECTURE.md 和 STACK.md。

主要能力

该工具的分析涵盖五个领域:

  1. 结构分析:理解项目如何组织,包括源代码目录及其用途、入口点(主文件、索引文件)、测试位置和模式、配置文件位置、资源目录。
  2. 依赖分析:映射项目依赖,包括运行时依赖(生产环境)、开发依赖、对等依赖、过时的包、安全漏洞。
  3. 模式分析:识别代码编写方式,包括命名约定、文件组织模式、错误处理方法、状态管理模式、API 模式。
  4. 集成分析:映射外部连接,包括使用的 API、数据库、第三方服务、环境依赖。
  5. 技术债务分析:暴露需要解决的问题,包括 TODO 和 FIXME、已弃用代码、缺失测试、不一致的模式、已知漏洞。

使用方式

工具描述了一个分阶段的扫描过程:

  • 阶段1:项目类型检测:根据标记文件识别项目类型,例如 package.json(Node.js/JavaScript)、requirements.txt 或 pyproject.toml(Python)、Cargo.toml(Rust)、go.mod(Go)、*.csproj(.NET)。
  • 阶段2:结构扫描:使用 PowerShell 命令获取目录结构,排除 node_modules、.git、pycache、dist、build、.next 等目录。
  • 阶段3:依赖提取:针对不同生态系统提取依赖,例如解析 package.json 中的 dependencies 和 devDependencies,读取 requirements.txt。
  • 阶段4:模式发现:搜索常见模式,例如组件(*.tsx, *.jsx)、API 路由(/api/)、模型/模式(interface|type|schema)。
  • 阶段5:债务发现:搜索 TODO|FIXME|HACK|XXX、@deprecated|DEPRECATED、console.(log|debug|warn) 等。

输出格式方面,ARCHITECTURE.md 包含概述、系统图、组件(目的、位置、依赖、被依赖)、数据流、集成点表格、约定(命名、结构、测试)、技术债务列表。STACK.md 包含运行时、生产依赖、开发依赖、基础设施、配置变量表格。

适用场景

该工具适用于需要快速理解陌生代码库、评估技术债务、记录项目架构或整理技术栈信息的场景。开发者或团队可以使用它来生成架构文档和技术栈文档。

限制

资料中未提供关于安装方式、收费模式、平台兼容性、具体性能效果等方面的信息。暂未提供这些细节。