SuperAPI AI 工具集

ast-grep-outline

编程与开发

查看项目

更新于 10-15 17:20

技能介绍

用途:ast-grep outline 打印源码的紧凑结构地图,带行号,展示顶层项(导入、函数、类、结构体、接口、模块、枚举)及其直接成员(字段、方法、构造函数、枚举变体)。它是本地、仅语法的视图,足够轻量,可在完整读取文件前运行。

主要能力:默认行为随输入变化——文件显示本地结构及成员摘要,目录只显示导出的公开表面并按名称分组。可用 --items 选择顶层项(structure、exports、imports、all),用 --view 控制细节(names、signatures、digest、expanded),用 --match 按名称或签名过滤顶层项(Rust 正则、区分大小写、不匹配成员),用 --type 只保留某些顶层符号类型,用 --pub-members 隐藏私有成员,用 --json=stream 输出每文件一个 JSON 对象及精确范围。

使用方式:编辑前了解文件,可运行 ast-grep outline <file>、ast-grep outline <file> --items imports 或 --items exports;扫描陌生目录,可运行 ast-grep outline <dir> --items exports 或 --type struct,enum,function;定位已知符号后列出成员,可运行 ast-grep outline <file> --match <symbol> --type class --view expanded;追踪依赖方向,可运行 ast-grep outline <dir> --items imports --view signatures;编辑后审查改动文件,可运行 ast-grep outline $(git diff --name-only HEAD) --items exports。

适用场景:分阶段阅读代码——先用搜索或文件名找候选文件,再 outline,最后只打开 outline 指向的源码范围。

限制:outline 只显示本地语法结构,不解析引用、不推断类型、不追踪重导出链、不构建调用图。这些问题应使用 ast-grep run、rg 或编译器支持的工具,再对它们找到的候选文件运行 outline。