gritql

遊び場 |チュートリアル |ドキュメント

---

GritQL は、ソース コードを検索および変更するための宣言型クエリ言語です。

• AST の詳細を学ばずに簡単に始められます。コード スニペットはすべて有効な GritQL クエリです。
• ⚡️ Rust とクエリの最適化を使用して 1,000 万行以上のリポジトリにスケールアップ
• ? 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

例

try-catch ブロック内にない限り、すべてのconsole.log呼び出しを削除します。

 `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 を反復すると非常に遅くなる可能性があります。
• Codemod フレームワークは言語固有であるため、複数の言語間を行き来する場合、または共有 API を移行しようとする場合は、さまざまなフレームワークを学習する必要があります。

GritQL は、強力な中間点を開発するための私たちの試みです。

• 探索的分析は簡単です。コード スニペットをバッククォートに配置し、表現したいホールに対して$metavariablesを使用するだけです。
• where 句で副条件を導入することで、段階的に複雑さが増します。
• 名前付きパターンを再利用してクエリの再構築を回避し、モジュールが確実にインポートされるようにするなどの一般的なタスクには標準ライブラリの共有パターンを使用します。
• 最大のパフォーマンスを実現するために Rust で書かれています。数百万行のコードを数秒で書き換えます。

謝辞

GritQL はすべての言語パーサーにツリーシッターを使用しており、Rust エコシステムから大きな恩恵を受けています。

GritQL は MIT ライセンスに基づいてリリースされています。

貢献する

貢献は大歓迎です。まず、貢献ガイドラインを確認してください。

Discordに参加することもできます。