git grepで、リポジトリの中のファイルを検索する方法

​​Git​コマンドライン

git grep <言葉> を実行すると、Git で管理しているファイルの中から、その言葉を含む行を探せます。関数や変数をどこで使っているかを調べたいときや、node_modules やビルドの結果を除いてプロジェクトの中を全文検索したいときに使える方法です。.gitignore で無視しているファイルや、まだ git add していないファイルは検索に入りません。検証環境で git のコマンドを実行し、出力をそのまま載せています。

補足

検証環境は Ubuntu 24.04、Git 2.43.0、比べるのに使った grep は GNU grep 3.11 です。作者の名前とメールアドレスには例示用の値(Neko <neko@example.com>)を設定しています。出力はファイルに書き出して取ったため、色は付いていません。Windows・macOS での動作、-P などの正規表現の種類の違い、サブモジュールの中の検索は試していません。

検索する前のリポジトリ

neko-app というリポジトリを用意しました。送料を計算する src/cart.js、説明の docs/guide.md、テストの tests/cart.test.js があり、コミットは2つです。最初のコミットには v1.0 のタグを付けています。

console
$ git ls-files
.gitignore
docs/guide.md
src/cart.js
tests/cart.test.js

$ git log --oneline
1c6b4b2 3000円以上で送料無料にする
2993652 最初のコミット

src/cart.js の中身は次のとおりです。

js
const SHIPPING_FEE = 500;
const FREE_SHIPPING_LINE = 3000;

function calcShipping(sum) {
  // 3000円以上なら送料無料
  if (sum >= FREE_SHIPPING_LINE) return 0;
  return SHIPPING_FEE;
}

function calcTotal(items) {
  const sum = items.reduce((a, i) => a + i.price, 0);
  return sum + calcShipping(sum);
}

module.exports = { calcTotal, calcShipping };

そのうえで、Git の管理に入れていないメモ(memo.txt)と、.gitignore で無視している node_modules/ と dist/ を置きました。大文字と小文字の違いはありますが、どれにも「shipping」という言葉が入っています。

console
$ git status --short --ignored
?? memo.txt
!! dist/
!! node_modules/

grep -r と git grep の結果を比べる

まず、ふつうの grep -r で、大文字と小文字を区別せずに(-i)「shipping」を探しました。.git フォルダーだけは除いています。

console
$ grep -rn -i shipping . --exclude-dir=.git
./src/cart.js:1:const SHIPPING_FEE = 500;
./src/cart.js:2:const FREE_SHIPPING_LINE = 3000;
./src/cart.js:4:function calcShipping(sum) {
./src/cart.js:6:  if (sum >= FREE_SHIPPING_LINE) return 0;
./src/cart.js:7:  return SHIPPING_FEE;
./src/cart.js:12:  return sum + calcShipping(sum);
./src/cart.js:15:module.exports = { calcTotal, calcShipping };
./dist/bundle.js:1:const SHIPPING_FEE=500;
./memo.txt:1:TODO: shipping の表示を確認する
./node_modules/shop/index.js:1:var shipping = 0;
./docs/guide.md:3:送料(shipping)は500円です。
./docs/guide.md:4:3000円以上で送料無料(free shipping)になります。

dist/、memo.txt、node_modules/ の中まで出てきます。同じ検索を git grep で行うと、Git で管理している src/cart.js と docs/guide.md だけが出ました。

console
$ git grep -i shipping
docs/guide.md:送料(shipping)は500円です。
docs/guide.md:3000円以上で送料無料(free shipping)になります。
src/cart.js:const SHIPPING_FEE = 500;
src/cart.js:const FREE_SHIPPING_LINE = 3000;
src/cart.js:function calcShipping(sum) {
src/cart.js:  if (sum >= FREE_SHIPPING_LINE) return 0;
src/cart.js:  return SHIPPING_FEE;
src/cart.js:  return sum + calcShipping(sum);
src/cart.js:module.exports = { calcTotal, calcShipping };

git grep の公式リファレンスにも、作業ツリーのうち Git が追跡しているファイル(tracked files)を検索すると書かれています。除くフォルダーを毎回指定しなくても、Git で管理しているファイルだけを調べられます。

行番号を出す(-n)

上の git grep の出力には、行番号がありません。-n を付けると、ファイル名の後ろに行番号が入ります。

console
$ git grep -n calcShipping
src/cart.js:4:function calcShipping(sum) {
src/cart.js:12:  return sum + calcShipping(sum);
src/cart.js:15:module.exports = { calcTotal, calcShipping };

calcShipping を定義している4行目と、使っている12行目・15行目が分かります。この後の例は、すべて -n を付けています。

大文字と小文字、単語の区切りを指定する(-i、-w)

-i を付けないと、大文字と小文字を区別します。「shipping」だけで探すと、小文字で書いた docs/guide.md の2行しか出ませんでした。

console
$ git grep -n shipping
docs/guide.md:3:送料(shipping)は500円です。
docs/guide.md:4:3000円以上で送料無料(free shipping)になります。

-w を付けると、単語として一致する行だけを出します。SHIPPING を -w 付きで探すと、何も出ませんでした。SHIPPING_FEE の中の SHIPPING は、後ろに _ が続いているためです。

console
$ git grep -n -w SHIPPING

$ git grep -n -w SHIPPING_FEE
src/cart.js:1:const SHIPPING_FEE = 500;
src/cart.js:7:  return SHIPPING_FEE;

公式リファレンスの -w の説明では、一致した部分の前後が行の端か、単語の一部にならない文字(non-word character)であることが条件です。この結果から、_ は単語の一部として扱われていることが分かります。

ファイル名だけ、件数だけを出す(-l、-c)

どのファイルに出てくるかだけを知りたいときは -l、ファイルごとに何行あるかを知りたいときは -c を使います。

console
$ git grep -l -i shipping
docs/guide.md
src/cart.js

$ git grep -c -i shipping
docs/guide.md:2
src/cart.js:7

探す場所を絞る(– の後ろにパス)

-- の後ろにフォルダーやファイルを書くと、そこだけを検索します。src だけで「shipping」を探しました。

console
$ git grep -n -i shipping -- src
src/cart.js:1:const SHIPPING_FEE = 500;
src/cart.js:2:const FREE_SHIPPING_LINE = 3000;
src/cart.js:4:function calcShipping(sum) {
src/cart.js:6:  if (sum >= FREE_SHIPPING_LINE) return 0;
src/cart.js:7:  return SHIPPING_FEE;
src/cart.js:12:  return sum + calcShipping(sum);
src/cart.js:15:module.exports = { calcTotal, calcShipping };

"*.js" のようにワイルドカードも使えます。calcTotal を探すと、src/ と tests/ のように、下のフォルダーにある .js からも見つかりました。

console
$ git grep -n calcTotal -- "*.js"
src/cart.js:10:function calcTotal(items) {
src/cart.js:15:module.exports = { calcTotal, calcShipping };
tests/cart.test.js:1:const { calcTotal } = require("../src/cart");
tests/cart.test.js:2:console.log(calcTotal([{ price: 100 }]) === 600);

反対に、特定のフォルダーを除きたいときは、名前の前に :! を付けます。テストを除いて calcTotal を探しました。

console
$ git grep -n calcTotal -- ':!tests'
src/cart.js:10:function calcTotal(items) {
src/cart.js:15:module.exports = { calcTotal, calcShipping };

:! は Git のパスの指定(pathspec)で、gitglossary の公式リファレンスでは、除く指定(exclude)として説明されています。! の代わりに ^ も使えます。

複数の言葉を組み合わせる(-e、–and、–not)

-e で言葉を並べると、どれか1つを含む行が出ます。「FREE」か「500」を含む行を探しました。

console
$ git grep -n -e FREE -e 500
docs/guide.md:3:送料(shipping)は500円です。
src/cart.js:1:const SHIPPING_FEE = 500;
src/cart.js:2:const FREE_SHIPPING_LINE = 3000;
src/cart.js:6:  if (sum >= FREE_SHIPPING_LINE) return 0;

両方を含む行だけにしたいときは、間に --and を入れます。ある言葉を含まない行にしたいときは --not です。

console
$ git grep -n -e SHIPPING --and -e 500
src/cart.js:1:const SHIPPING_FEE = 500;

$ git grep -n -e shipping --and --not -e free
docs/guide.md:3:送料(shipping)は500円です。

2つめは、「shipping」を含み、「free」を含まない行です。公式リファレンスの –and の説明によると、何も書かないときは --or でつながり、--and や --not で組み合わせるときは、すべての言葉に -e が要ります。

どの関数の中で見つかったかを出す(-p)

-p を付けると、見つかった行がどの関数の中にあるかを一緒に出します。return を探しました。

console
$ git grep -n -p return
src/cart.js=4=function calcShipping(sum) {
src/cart.js:6:  if (sum >= FREE_SHIPPING_LINE) return 0;
src/cart.js:7:  return SHIPPING_FEE;
src/cart.js=10=function calcTotal(items) {
src/cart.js:12:  return sum + calcShipping(sum);

= で区切られた行が関数の名前の行で、: で区切られた行が見つかった行です。6行目と7行目は calcShipping の中、12行目は calcTotal の中だと分かります。

関数の名前の行は、git diff の変更のまとまりの見出し(hunk header)と同じ決め方で選ばれます(公式リファレンスの -p の説明)。gitattributes の公式リファレンスにある、hunk header の決め方の説明によると、何も設定しなければ、英字・_・$ で始まる行です。インデントした行は選ばれないので、この例では関数を定義している行が出ました。

ファイルごとにまとめて表示する(–heading、–break)

見つかる行が多いときは、--heading でファイル名を上に1回だけ出し、--break でファイルの間に空行を入れると読みやすくなります。

console
$ git grep -n --heading --break -i free
docs/guide.md
4:3000円以上で送料無料(free shipping)になります。

src/cart.js
2:const FREE_SHIPPING_LINE = 3000;
6:  if (sum >= FREE_SHIPPING_LINE) return 0;

管理していないファイルも検索する(–untracked)

git grep は、Git で管理していないファイルを、名前を指定しても検索しません。memo.txt、node_modules、dist を指定すると、何も出さずに終了コード 1 で終わりました。

console
$ git grep -n -i shipping -- memo.txt node_modules dist; echo "exit=$?"
exit=1

まだ git add していないファイルも含めたいときは、--untracked を付けます。このとき、オプションを検索する言葉の後ろに書くと、エラーになりました。

console
$ git grep -n -i shipping --untracked
fatal: option '--untracked' must come before non-option arguments

メッセージのとおり、--untracked を言葉の前に移すと、memo.txt も検索に入りました。

console
$ git grep -n -i --untracked shipping
docs/guide.md:3:送料(shipping)は500円です。
docs/guide.md:4:3000円以上で送料無料(free shipping)になります。
memo.txt:1:TODO: shipping の表示を確認する
src/cart.js:1:const SHIPPING_FEE = 500;
src/cart.js:2:const FREE_SHIPPING_LINE = 3000;
src/cart.js:4:function calcShipping(sum) {
src/cart.js:6:  if (sum >= FREE_SHIPPING_LINE) return 0;
src/cart.js:7:  return SHIPPING_FEE;
src/cart.js:12:  return sum + calcShipping(sum);
src/cart.js:15:module.exports = { calcTotal, calcShipping };

node_modules/ と dist/ は、--untracked だけではまだ入りません。.gitignore で無視しているものまで含めるには、--no-exclude-standard も足します。

console
$ git grep -n -i --untracked --no-exclude-standard shipping
dist/bundle.js:1:const SHIPPING_FEE=500;
docs/guide.md:3:送料(shipping)は500円です。
docs/guide.md:4:3000円以上で送料無料(free shipping)になります。
memo.txt:1:TODO: shipping の表示を確認する
node_modules/shop/index.js:1:var shipping = 0;
src/cart.js:1:const SHIPPING_FEE = 500;
src/cart.js:2:const FREE_SHIPPING_LINE = 3000;
src/cart.js:4:function calcShipping(sum) {
src/cart.js:6:  if (sum >= FREE_SHIPPING_LINE) return 0;
src/cart.js:7:  return SHIPPING_FEE;
src/cart.js:12:  return sum + calcShipping(sum);
src/cart.js:15:module.exports = { calcTotal, calcShipping };

これで、最初の grep -r と同じファイルが出そろいました。公式リファレンスの –no-exclude-standard の説明にも、このオプションは --untracked と一緒に使うときだけ意味があると書かれています。

過去のコミットやタグの中を検索する

言葉の後ろにタグやブランチの名前、コミットを書くと、今のファイルではなく、その時点の中身を検索します。今いるブランチを切り替える必要はありません。

console
$ git grep -n FREE v1.0; echo "exit=$?"
exit=1

$ git grep -n SHIPPING_FEE v1.0
v1.0:src/cart.js:1:const SHIPPING_FEE = 500;
v1.0:src/cart.js:5:  return sum + SHIPPING_FEE;

v1.0 の時点では、送料無料の FREE はまだなく、SHIPPING_FEE は5行目で使われていました。出力の頭には、どの時点の結果かを示す v1.0: が付きます。

コミットを2つ並べると、両方を検索します。HEAD~1(1つ前のコミット)と HEAD で FREE を探すと、HEAD からだけ見つかりました。

console
$ git grep -n FREE HEAD~1 HEAD
HEAD:src/cart.js:2:const FREE_SHIPPING_LINE = 3000;
HEAD:src/cart.js:6:  if (sum >= FREE_SHIPPING_LINE) return 0;

見つかったかどうかを終了コードで確かめる

見つからなかったときは、何も表示せずに終了コード 1 で終わります。-q を付けると、見つかっても行を表示せず、終了コード 0 だけを返します。

console
$ git grep -n neko; echo "exit=$?"
exit=1

$ git grep -q calcTotal; echo "exit=$?"
exit=0

公式リファレンスの -q の説明にも、見つかったときは 0、見つからないときは 0 以外で終わると書かれています。シェルスクリプトの if で、ある言葉が残っていないかを確かめるときに使えます。

最後に、検索した後の作業ツリーの状態を見ました。検索の前と同じで、git grep はファイルに何も手を加えていません。

console
$ git status --short --ignored
?? memo.txt
!! dist/
!! node_modules/

​Posted by 86