Codemod grep: 公開GitHubリポジトリを横断する構造的コード検索

Codemod grepは、プレーンテキストではなく構造に基づいて動作する新しいコード検索エンジンです。ast-grepのパターン構文を使用して、構文ツリーの形状でコードをマッチングするため、正規表現やテキスト検索では見つからないパターンを公開GitHubリポジトリ全体から見つけられます。

何が違うのか

正確な文字列やあいまいな正規表現のマッチングではなく、コード構造を表すパターンを書きます。例えば、パターンconsole.log($MSG)は、任意の引数を持つconsole.log呼び出しにマッチします。同様に、$A.$B($C)は、単一の引数を持つ任意のオブジェクトのメソッド呼び出しにマッチし、await $EXPRはawait式を見つけます。

このツールはHTMLパターンの構造検索もサポートしており、alt属性のない<img>タグなど、正規表現では難しいが構造的マッチングでは簡単な検索が可能です。

使い方

インターフェースはシンプルです。検索ボックスにast-grepパターンを入力し、必要に応じてYAMLルールモードに切り替えてより複雑な条件を指定し、検索を実行します。従来の文字列マッチング用の正規表現モードや、自然言語クエリ用の「Ask AI」機能もあります。

内部的には、ast-grepのCLIで使用されるのとまったく同じパターン構文を利用しているため、ast-grepルールの書き方を知っていれば、そのスキルをここで再利用できます。クイックスタートとして、ホームページにはconsole.log($MSG)、$A.$B($C)、await $EXPRなどのサンプルパターンがあります。

誰向けか

大規模なコードベースで作業する開発者、リポジトリ横断的なリファクタリングを行う開発者、オープンソースエコシステム全体でコードパターンを監査する必要がある開発者に最適です。また、特定のAPIが実際にどのように使われているかを発見するのにも最適です。

grep.codemod.comにアクセスして、独自のパターンで試してみてください。