SuperAPI AI 工具集

understand-codebase

编程与开发

查看项目

更新于 10-16 08:11

技能介绍

understand-codebase 用于在导航代码、追踪函数与类之间的连接、查找符号定义或调用位置、回答代码库「如何工作」类问题时使用。

工具选择:结构化模式(函数、类、语法、调用流)用 sg(ast-grep);文本模式(字符串、注释、名称)用 rg(ripgrep);按名称或扩展名发现文件用 fd。需要先找文件时,先 fd 再管道给 rg 或 sg;需要语法感知匹配时用 sg;需要快速文本或正则搜索时用 rg;不确定时先用更快的 rg,结构重要时再升级到 sg。

用法示例(命令保持原样):结构化搜索 sg -p 'console.log($MSG)' -l js;rg 'TODO' --type js;fd -e ts -e tsx src/。常见模式包括代码库探索(查找入口点、类定义、模块导入)、重构前分析(查找函数用法、方法调用、变量赋值)、安全审计(硬编码密钥、SQL 注入风险、eval 使用、console 语句清理)、错误处理分析(try-catch 块、空 catch、缺少错误处理的异步函数)、依赖分析(包导入、require、动态 import)。

性能建议:先用 fd 缩小文件范围再搜索内容,使用文件类型过滤提高速度,并用 -g 或 -E 排除 node_modules、dist、build 等构建产物。

高级用法可参考 references/ast-grep.md(元变量、关系规则、复合模式)、references/ripgrep.md(正则语法、过滤、替换)、references/fd.md(类型过滤、执行、基于时间的搜索)。

限制与未提供信息:未提供安装方式、收费与价格、支持平台、具体版本要求、性能基准与成效数据,暂未提供。