ast-grep(sg)是一个基于抽象语法树(AST)的多语言代码搜索、lint 与重写工具,适合在正则表达式难以胜任的场合做结构化搜索和替换。
主要用途:基于结构查找代码,例如查找“所有对 foo 的、带两个参数的函数调用”,且不受空白影响;重构代码,如重命名变量、修改函数签名或安全地转换代码模式;编写自定义规则以强制代码风格或最佳实践;从代码库中提取信息做代码分析。
使用方式:命令行为基础。搜索时模式需放在单引号内,例如:ast-grep -p '$A + $B' --lang ts。重写(试运行):ast-grep -p '$A != null' --rewrite '$A' --lang ts。交互式重写:ast-grep -p 'var $A = $B' --rewrite 'const $A = $B' --interactive。常用命令包括 scan、run、new、test、lsp。
模式语法:$VAR 匹配任意单个节点;$$$ARGS 匹配零个或多个节点(列表);$_ 匹配任意节点(不捕获);$$ 匹配任意节点列表(不捕获)。使用精确模式时需理解命名节点与非命名节点,以及匹配严格度(smart、cst、ast、relaxed、signature)。
复杂任务可使用 YAML 规则配置,例如定义 no-console-log,language 为 TypeScript,pattern 为 console.log($$$ARGS),inside 指定 kind: function_declaration、stopBy: end,fix 为空以移除日志。还支持正则替换、大小写转换等高级重写,以及用于子节点转换的 rewriter。
在较大项目中可用 sgconfig.yml 组织规则与测试:脚手架命令为 ast-grep new project;配置定义规则目录与测试目录;通过定义有效与无效用例验证规则准确性;可用本地或全局 utility 规则复用逻辑,例如 utils 中定义 is-literal(any 包含 kind: string 与 kind: number),再在 rule 中通过 matches: is-literal 引用。配置参考涵盖 id、severity、files、ignores 等 YAML 字段及支持的语言。
限制:资料未提供具体收费、价格、支持语言的完整清单、性能数据或平台要求,这些方面暂未提供,需查阅官方文档确认。