探索代码结构的革命：ast-grep(sg)——你的代码搜索与重构利器

ast-grep(sg) 是一个基于命令行的工具，用于以抽象语法树（AST）为基础进行代码结构搜索、检查和改造。它将传统的文本匹配提升到一个新的层次，允许您以编程方式定义查找模式，并以相同结构匹配所有代码。

项目介绍

想象一下，有一个工具能像grep那样工作，但它的匹配对象不是文本而是代码的语法结构。这就是ast-grep(sg) 。通过它，您可以编写类似于普通代码的模式，其中$MATCH等符号作为通配符，来匹配任何单个AST节点。这就像正则表达式的.，只是它处理的是代码结构而非字符串。

立即尝试在线Playground，感受它的魅力！

动态演示

安装

ast-grep(sg) 支持多种安装方式，包括npm、pip、cargo、homebrew、scoop 和 MacPorts。只需一行命令即可轻松完成安装：

npm install --global @ast-grep/cli
pip install ast-grep-cli
cargo install ast-grep
# 或其他平台对应的命令...

使用示例

ast-grep(sg) 具有如下的命令行形式：

sg --pattern 'var code = $PATTERN' --rewrite 'let code = new $PATTERN' --lang ts

例如，你可以重写使用空合并运算符的代码：

sg -p '$A && $A()' -l ts -r '$A?.()'

或在Zodios库迁移中使用它：

sg -p 'new Zodios($URL,  $CONF as const,)' -l ts -r 'new Zodios($URL, $CONF)' -i

甚至用YAML配置自定义ESLint规则：

sg -p '...your_pattern...' -l lang -r '...replacement...' -i

关键特性

1. 直观的模式匹配：模式设计得如同日常编码一般直观，使得寻找和替换AST节点变得简单。
2. jQuery式API：提供类似jQuery的API，方便进行AST遍历和操作。
3. YAML配置：通过YAML创建新的 lint 规则或代码修改策略，简化任务设置。
4. 高性能：利用编译语言和tree-sitter解析器以及多核处理器，实现高效运行。
5. 出色的CLI界面：美观易用的命令行界面提高了用户的交互体验。

应用场景

ast-grep(sg) 可广泛应用于以下领域：

• 开源库开发者：帮助用户更平滑地过渡到库的破坏性变更。
• 团队技术负责人：实施定制化的代码最佳实践，确保代码质量。
• 安全研究员：快速构建规则，进行安全审计和漏洞检测。

结论

无论你是开发人员、技术领导者还是安全专家，ast-grep(sg) 都是值得你拥有的强大工具，它可以帮你释放AST的潜力，让代码搜索和重构变得更加简单和高效。现在就加入并探索这个令人惊叹的开源项目吧！