gritql

游乐场|教程 |文档

---

GritQL 是一种用于搜索和修改源代码的声明性查询语言。

• 简单地开始，无需学习 AST 详细信息：任何代码片段都是有效的 GritQL 查询
• ⚡️ 使用 Rust 和查询优化可扩展至 10M+ 行存储库
• ？使用 Grit 的内置模块系统重用 200 多个标准模式或分享您自己的模式
• ♻️ 一旦学习了 GritQL，您就可以用它来重写任何目标语言：JavaScript/TypeScript、Python、JSON、Java、Terraform、Solidity、CSS、Markdown、YAML、Rust、Go 或 SQL
• ？ GritQL 可以轻松包含自动修复规则，以实现更快的修复

入门

阅读文档、交互式教程或运行grit --help 。

安装

安装 Grit CLI：

 curl -fsSL https://docs.grit.io/install | bash

用法

通过将所需的模式放在反引号中来搜索所有console.log调用：

 grit apply '`console.log($_)`'

将console.log替换为winston.log ，使用=>创建重写：

 grit apply '`console.log($msg)` => `winston.log($msg)`'

将模式保存到grit.yaml文件并排除 where 子句中的测试用例：

 cat << 'EOF' > .grit/grit.yaml
patterns:
  - name: use_winston
    level: error
    body: |
      `console.log($msg)` => `winston.log($msg)` where {
        $msg <: not within or { `it($_, $_)`, `test($_, $_)`, `describe($_, $_)` }
      }
EOF
grit apply use_winston

运行grit check以将您的模式强制执行为自定义 lint。

 grit check

示例

删除所有console.log调用，除非它们位于 try-catch 块内

 `console.log($log)` => . where {
  $log <: not within `try { $_ } catch { $_ }`
}

用新的方法调用替换方法调用

 `$instance.oldMethod($args)` => `$instance.newMethod($args)` where {
  $program <: contains `$instance = new TargetClass($_)`
}

更多示例

在 GritQL 标准库中可以找到更多示例。

可以组合模式来创建复杂的查询，包括大型重构。

为什么选择 GritQL？

GritQL 来自我们进行大规模重构和迁移的经验。

通常，迁移从探索性工作开始，以找出问题的范围——通常使用简单的 grep 搜索。这些很容易开始，但大多数迁移最终都会积累额外的要求，例如确保导入正确的包以及排除没有可行迁移路径的情况。

最终，任何复杂的迁移最终都会成为使用 jscodeshift 等工具编写的完整 codemod 程序。这也有其自身的问题：

• 当您弄清楚如何将原始正则表达式搜索表示为 AST 时，大部分探索性工作都必须放弃。
• 读/写 codemod 需要在心里将 AST 名称翻译回源代码实际的样子。
• 大多数框架都是不可组合的，因此您不得不来回复制模式。
• 性能通常是事后才考虑的，因此迭代大型代码模型可能会非常缓慢。
• Codemod 框架是特定于语言的，因此如果您要在多种语言之间切换，或者尝试迁移共享 API，则必须学习不同的框架。

GritQL 是我们开发强大中间立场的尝试：

• 探索性分析很简单：只需将代码片段放在反引号中，然后使用$metavariables来表示您想要表示的漏洞。
• 通过引入带有 where 子句的附加条件来逐渐增加复杂性。
• 重用命名模式以避免重建查询，并使用我们标准库中的共享模式来执行常见任务，例如确保导入模块。
• 用 Rust 编写以获得最大性能：在几秒钟内重写数百万行代码。

致谢

GritQL 对所有语言解析器使用树守护者，并从 Rust 生态系统中受益匪浅。

GritQL 在 MIT 许可证下发布。

贡献

欢迎贡献。首先，请查看贡献指南。

您也可以加入我们的Discord 。