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 。