目次

ripgrep(rg)は、ディレクトリを再帰的に検索しながら、.gitignoreなどの除外ルールも適用する検索ツールです。まずはrg '検索語'を試し、見つからないファイルがあるときは検索対象の絞り込み設定を確認しましょう。

要点#

  • rgは標準で.gitignore、.ignore、.rgignoreを読み、隠しファイルとバイナリも検索対象から外します。
  • -tでファイル種別を指定し、-nで行番号を表示できます。
  • 除外ルールを無視してすべて検索するには-uuuを使います。
  • 既定の正規表現では先読みや後方参照を使えず、必要ならPCRE2を有効にします。

まずは検索する#

プロジェクトのルートで、検索したい文字列を渡します。特別な指定がなくても配下のファイルを再帰的に調べ、結果にはファイル名と該当行が表示されます。

example.sh
rg 'TODO'
rg -n 'TODO'

2つ目のコマンドは行番号も出力します。特定のファイルだけを調べるなら、パターンの後にパスを指定します。正規表現も使えるので、たとえば大文字の識別子を探す場合は[A-Z]+_SUSPENDのように書けます。

対象を絞り込む#

拡張子やファイル種別で検索範囲を限定すると、結果を読みやすくできます。Pythonファイルだけなら-tpy、JavaScriptを除外するなら-Tjsを指定します。

example.sh
rg -tpy 'def main'
rg -Tjs 'fetch'

対応する種別や独自の種別ルールは設定できます。大規模なリポジトリでは、まず対象を絞って検索すると、不要な結果を避けやすくなります。

除外されたファイルを探す#

rgは.gitignoreなどのルールに一致するファイルに加え、隠しファイルとバイナリも既定で検索しません。設定ファイルや生成物の中に文字列があるはずなのに見つからないときは、除外設定が原因か確認します。

すべての自動フィルタリングを外すには-uuuを追加します。検索量が大きくなりやすいので、必要なときだけ使うのが実用的です。

example.sh
rg -uuu '設定値'

正規表現と特殊な入力#

既定の正規表現エンジンはUnicodeに対応し、通常の検索を高速に実行します。一方、先読みや後方参照はサポートしません。これらが必要な場合は、PCRE2対応でビルドされたrgで-Pを指定します。

example.sh
rg -P '(?<=user_id=)\d+'

PCRE2は常に使う必要はありません。ビルド時に有効化されているか分からない場合は、rg --helpや利用中のパッケージ情報を確認してください。

UTF-8以外の文字コードや圧縮ファイルも検索できます。文字コードは-E、対応する圧縮ファイルは-zで指定します。

example.sh
rg -E Shift_JIS '検索語' data.txt
rg -z '検索語' archive.gz

速度と使い分け#

ripgrepはRustの正規表現エンジンや並列ディレクトリ走査などを使い、検索を速くする設計です。GitHubのREADMEにあるLinuxカーネルの比較例では、指定された条件でrgは0.082秒、git grepは0.273秒でした。ただし、この数字は特定のマシンと検索条件での結果です。手元の環境で同じ差が出るとは限りません。

Windows、macOS、Linuxで利用できますが、POSIX標準のツールではなく、すべての環境に最初から入っているわけでもありません。追加インストールが難しい環境では、標準的なgrepが使いやすい場合があります。

次の一歩#

プロジェクトのルートでrg -n 'TODO'を実行し、結果に出ないファイルを探す必要があれば、続けてrg -uuu -n 'TODO'を試してください。

出典: https://github.com/burntsushi/ripgrep

目次