SuperAPI AI 工具集

ast-grep Search

编程与开发

查看项目

更新于 11-11 01:09

技能介绍

用途

ast-grep Search 是一个面向 AI 编程助手的使用知识条目,主题是 ast-grep:一款基于抽象语法树(AST)的结构化代码搜索与重构工具。它适合在需要按代码结构而非纯文本查找、批量重写代码、进行语义层面的代码分析或编写自定义 lint 规则时参考。

主要能力

  • 基于 AST 的结构化模式匹配,比文本搜索更精确。
  • 使用 Rust 编写,支持多核处理,强调速度。
  • 通过 tree-sitter 支持 20 多种语言,包括 JavaScript、TypeScript、Python、Java、Go、Rust、C++、C、C#、Ruby、PHP、Swift、Kotlin、Scala、HTML、CSS、YAML、JSON 等。
  • 模式代码语法:直接用代码写匹配模式,支持 $VAR、$$VAR、$$$ARGS、$_ 等元变量。
  • 内置重写能力,可将匹配结果替换为指定模式。
  • 交互模式,便于在应用修改前逐条审查。
  • 支持语言服务器协议(LSP),可用于编辑器集成。
  • 支持 YAML 规则配置,用于自定义 lint。

使用方式

资料给出了命令行用法示例,包括:

  • 基本模式搜索:ast-grep -p 'console.log($MSG)' --lang js。
  • 搜索并重写:ast-grep -p 'var $VAR = $VAL' -r 'let $VAR = $VAL' --lang js。
  • 交互模式:加 -i;自动应用全部修改:加 -U。
  • 主要子命令:run(一次性搜索或重写)、scan(按 YAML 配置扫描)、test(测试规则)、new(创建项目/规则/测试模板)、lsp(启动语言服务器)。
  • 常用参数:-p/--pattern、-r/--rewrite、-l/--lang、-i/--interactive、-U/--update-all、--json、-A/-B/-C(上下文行)、--color、--heading、--debug-query。
  • 输出格式支持默认彩色分组、JSON 及其 pretty/stream/compact 变体。

规则配置方面,YAML 规则文件可包含 id、language、severity、message、note、url、rule、constraints、utils、transform、fix、labels、files、ignores、metadata 等字段。规则类型包括原子规则(pattern、kind、regex)、关系规则(has、inside、follows、precedes)、组合规则(all、any、not、matches)以及可复用 utility 规则。约束可按 regex、kind、pattern 过滤元变量;变换支持 replace、substring、convert(大小写转换)。文件匹配支持 files 与 ignores glob。

规则测试方面,资料说明可在规则同目录创建 *-test.yml 测试文件,包含 valid 与 invalid 用例或输入/输出快照,并用 ast-grep test 运行。项目初始化用 ast-grep new project my-linter,会生成 sgconfig.yml、rules/、utils/ 等目录结构。

适用场景

资料列举的实践用途包括:代码质量与 lint(查找遗留的 console.log、TODO 注释、魔法数字、过长参数列表、空 catch 块)、安全分析(查找 eval、SQL 字符串拼接、密码变量、os.system、innerHTML 赋值、document.write)、重构(var 改 let/const、函数转箭头函数、更新导入路径、重命名 API 调用、回调转 async/await)等。也给出了 JavaScript/TypeScript、Python、Rust、Go 等语言的模式示例。

限制

资料未提供该技能的安装方式、运行环境要求、版本兼容性、收费或授权信息、性能基准数据及实际使用效果评估,这些事实暂未提供。