git logのオプション（中編）

前回の記事でも中々の数のgit logのオプションを紹介しましたが、まだまだ続きます。

前回はコミットについて「どういった内容を出力するか」を選択するようなオプションを紹介しました。対して今回は、「どのコミットを出力するか」という、コミットを絞るようなオプションを紹介します。例えば、「2020年のコミットだけを出力する」「index.htmlを変更したコミットだけを出力する」といった具合です。

リポジトリーの再現

前回作成したリポジトリーを引き続き使用します。以下の内容を実行することで、リポジトリーを再現することができます。

スクリプトを見る

  # index.htmlを作成 
  touch index.html
  git add .
  git commit -m "Create index.html"

  # index.htmlを編集
  echo -e "aaa\nbbb\nccc" >> index.html
  git add .
  git commit -m "Edit index.html"

  # style.cssを作成
  touch style.css
  git add .
  git commit -m "Create style.css"

  # index.htmlを編集
  echo -e "aaaaaa\nbbb" > index.html
  git add .
  git commit -m "2nd Edit index.html"

  # index.htmlをejsファイルに変更
  git mv index.html index.ejs
  git commit -m "Rename index.html"

  # index.ejsを削除
  git rm index.ejs
  git commit -m "Remove index.ejs"

`-n <number>`でコミット数を絞る

-nオプションで、出力させるコミット数を指定することができます。例えば-n 1なら1コミット、-n 10なら10コミット出力されます。もしくは、-10のように-に続けて数値を打っても構いません。

$ git log -n 2 --oneline
8359ebb (HEAD -> master, style.css) Remove index.ejs
ae45f13 Rename index.html

とりあえず直近のコミットを確認したい時にgit logと打って何百とコミットが出力されるとうっとうしいので、私はエイリアスで最初からコミット数上限を10に指定しています。

[alias]
  # コミット数をデフォルトで10に制限
  lol = log --all --graph --oneline -10

なお、10よりもさらに多くのコミットを確認したい場合は、コマンド実行時にgit lol -n 30などと指定すればその数だけコミットが出力されます。

`--grep`でコミットメッセージで検索する

--grep=任意の文字とすることで、コミットメッセージによってコミットを検索することができます。以下の例だと、コミットメッセージにRenameが含まれているコミットが出力されます。

$ git log --oneline --grep=Rename

cb039c3 (HEAD -> main) Rename index.html

なお、--grepのみで検索するとcase sensitive、つまり、アルファベットの大文字小文字が区別されます。例えば--grep=renameとすると出力されません。

$ git log --oneline --grep=rename

この場合、-i（--regexp-ignore-caseのショートハンド）を付与すると、大文字小文字区別なく出力されます。

$ git log --oneline -i --grep=Rename

ae45f13 Rename index.html

また、検索する文字列には正規表現が使用できます。

# 先頭がEのコミットメッセージのみ出力
$ git log --grep=^E --oneline

dc38817 Edit index.html

--grepの結果を反転させる、つまり、Renameを含むコミットメッセージを除くには、--invert-grepを付与します。

$ git log --grep=Rename --invert-grep --oneline

8359ebb (HEAD -> master, style.css) Remove index.ejs
1edf947 2nd Edit index.html
5a3abbc Create style.css
dc38817 Edit index.html
a81b18d Create index.html

ORとAND

--grepを複数使用した場合、ORでコミットメッセージが検索されます。以下の例だと、RenameもしくはCreateが含まれているコミットが出力されます。

$ git log --oneline --grep="Rename" --grep="Create"

ae45f13 Rename index.html
5a3abbc Create style.css
a81b18d Create index.html

これをANDにしたい場合、--all-matchを付与します。以下の例だと、Createとhtmlが両方含まれているコミットが出力されます。

$ git log --oneline --all-match --grep="Create" --grep="html"

a81b18d Create index.html

`-- <path>`で特定のファイルの履歴を確認する

任意のファイルに変更があったコミットのみ出力する場合には、-- [path]と記述します。--statや-pと組み合わせることも可能です。

console

# index.ejsのみ
$ git log --oneline -- index.ejs

8359ebb (HEAD -> master, style.css) Remove index.ejs

ae45f13 Rename index.html

# style.cssのみ
$ git log --oneline -- style.css

4aefdf3 Create style.css

なお、パスの前に--を付与していますが、これはgit logに「渡しているのはファイル名だよ」と伝える意味を持っています。

あれ？index.htmlが引っかからないけど

今回の例では、index.htmlからindex.ejsにファイル名を変更しています。-- index.ejsで検索しても、index.htmlが対象のコミットは出力されません。

今回のように、既にワーキングツリーに存在していないファイルのコミットも検索したい場合は、--followオプションを付けてください。リネーム前のindex.htmlも検索対象になります。

なお、引数の順番は注意が必要です。--follow -- ファイル名としなければ旧ファイルが検索されませんでした（git version 2.22.0）。

console

$ git log --oneline --follow -- index.ejs

d7e6535 (HEAD -> main) Delete index.ejs

cb039c3 Rename index.html

360e27d 2nd Edit index.html

be1bf08 Edit index.html

fd4955b Create index.html

パスの前に`--`を付けるのはどんな時？

ファイルやパスを記述してコミット履歴を絞るには--を付与すると説明しましたが、実は--はつけなくても、多くの場合はちゃんと動作します。つけなくてはいけない場合について、いくつか検証してみます。

現在、index.ejsは削除されていますが、ここで--をつけずにindex.ejsを指定するとエラーになってしまいます。

# -- なしで実行
$ git log --oneline index.ejs

fatal: ambiguous argument 'index.ejs': unknown revision or path not in the working tree.
Use '--' to separate paths from revisions, like this:
'git <command> [<revision>...] -- [<file>...]'

ambiguous argument、つまり「曖昧な引数」というメッセージが出力され、ご丁寧に「ファイル名の前に--をつけてね」というアドバイスまでくれています。どうやら、削除やリネームを行って、ワーキングツリーに存在しなくなったファイルを検索する場合には--が必要らしいです。

ワーキングツリーに存在しているstyle.cssであれば--なしでも検索できます。

$ git log --oneline style.css

4aefdf3 Create style.css

次に、ファイル名と同じブランチが切られている場合について検証します。

今、ワーキングツリーにはstyle.cssがありますから、style.cssという名前のブランチを切ります。特にコミットはしなくてOKです。

console

$  git checkout -b style.css

ここで--を渡さないでgit logを実行すると

console


$ git checkout main

$ git log --stat --oneline develop

fatal: ambiguous argument 'develop': both revision and filename
Use '--' to separate paths from revisions, like this:
'git <command> [<revision>...] -- [<file>...]'

またしてもambiguous argument、「曖昧な引数」のため致命的なエラーが発生しています。「style.cssファイルもあるしstyle.cssブランチもあるけど、どっちのこと言ってるの？」と言われています。

-- style.cssとすることでエラーなく出力されることも確認しておきます。

console

$ git log --oneline -- style.css

4aefdf3 Create style.css

まとめると、

🤔 基本的には--なしでもファイルでコミットを絞れる
🤔 ただし、ワーキングツリーにないファイルで絞る場合には--を付与する
🤔 ファイル名とブランチ名が被っている場合にも--を付与する

と考えていいと思います。

なお、私は常に--を付与している派です。

`--diff-filter`で変更内容でコミットを絞る

--diff-filterオプションを付けることで、「ファイルが削除されたコミットだけ」「リネームされたコミットだけ」という風にコミットを出力することができます。

--diff-filter=Dという風に指定してみます。DはDeletedのことです。つまり、ファイルが削除されたコミットのみが出力されます。

$ git log --oneline --diff-filter=D

d7e6535 (HEAD -> main) Delete index.ejs

D以外にも、以下のような値が渡せます。

値	コミットの内容
A(Added)	追加
M(Modify)	変更
R(Renamed)	リネーム
C(Copied)	ファイルコピー
T(Type?)	タイプが変更（シンボリックリンクへの変更など）

# ファイルを新しく追加したコミットのみ
$ git log --oneline --diff-filter=A
4aefdf3 Create style.css
fd4955b Create index.html

# ファイルの内容を変更したコミットのみ
$ git log --oneline --diff-filter=M
360e27d 2nd Edit index.html
be1bf08 Edit index.html

# ファイルをリネームしたコミットのみ
$ git log --oneline --diff-filter=R
ae45f13 Rename index.html

# ファイルをコピーしたコミットのみ（今回の例では該当なし）
$ git log --oneline --diff-filter=C

そして、値を小文字にすることで意味を反転させることができます。つまり、--diff-filter=dとすると、削除があったコミット以外が出力されます。

$ git log --oneline --diff-filter=d

ae45f13 Rename index.html

1edf947 2nd Edit index.html

5a3abbc Create style.css

dc38817 Edit index.html

a81b18d Create index.html

`--since`と`--until`で日付で絞る

以下のようなコミット履歴があるとします。2017年から2020年まで、各年の1月1日にコミットを行っており、計4回のコミット履歴があります。

console

$ git log --format=fuller

commit 13a83c31fc4558b811ae2c0dbb373a60d2359c77 (HEAD -> main)
Author:     toriwatari <toriwatari@toriwatari.com>
Date: Fri Jan 10 00:00:00 2020 +0900

    2020 commit

commit 0fb21bf1e009cd3edb4036bc167db0cb93c1c98b
Author:     toriwatari <toriwatari@toriwatari.com>
Date: Tue Jan 1 00:00:00 2019 +0900

    2019 commit

commit 41ece2df6ad958e89ae9ba91e08d82c3d476ec9d
Author:     toriwatari <toriwatari@toriwatari.com>
Date: Mon Jan 1 00:00:00 2018 +0900

    2018 commit

commit d4657a563990338265ed5af1ff90f8e971546560
Author:     toriwatari <toriwatari@toriwatari.com>
Date: Sun Jan 1 00:00:00 2017 +0900

    2017 commit

--sinse="<date>"とすることで任意の日付以降にコミットされたコミットのみ出力できます。以下の例だと、2018年1月1日以降を表します。

$ git log --since="2018-01-01:00:00:00" --oneline
13a83c3 (HEAD -> main) 2020 commit
0fb21bf 2019 commit
41ece2d 2018 commit

日付のフォーマットですが色々なものに対応しているようです。

console

# YYYY-MM-DD
$ git log --since="2018-01-01"

# YYYY/MM/DD
$ git log --since="2018/01/01"

# YYYY MM DD
$ git log --since="2018 01 01"

# DD/MM/YYYY
$ git log --since="01/01/2018"

# UNIXタイムスタンプ
$ git log --since="1514732400"

# 10週間前
$ git log --since="10 week age"

# 先月
$ git log --since="last month"

なお、フォーマットの一部のみ指定した場合の動作ですが、指定していない箇所は現在の日時で補完されるようです。以下の例では、YYYYに当たる2019のみ指定していますが動作します。ただ、2019年1月1日のコミットは表示されません。予想ですが、実行した日付の3月3日とその時間で絞り込みされることになると想像しました。

console

$ git log --since="2019" # YYYYのみ
commit 13a83c31fc4558b811ae2c0dbb373a60d2359c77 (HEAD -> main)
Author: toriwatari <toriwatari@toriwatari.com>
Date:   Fri Jan 10 00:00:00 2020 +0900

    2020 commit

 # 今日は2020/03/03なので、
 # --since="2019/03/03(+その時の時間)"とみなされる?

検証したところ上記のようになっていると推察したのですが自信はありません。

--untilは--sinceの逆、任意の日付以前にコミットされたコミットのみ出力します。

console

$ git log --until="2018-01-01:00:00:00" --oneline

# 2018年1月1日以前
41ece2d 2018 commit
d4657a5 2017 commit

また、--sinceと--untilを組み合わせることで「〇〇日以降、〇〇日以前」という風に日時を絞り込めます。

console

$ git log --since="2017-06-30" --until="2018-06-29" --oneline

41ece2d 2018 commit

`--relative-date`で日付を相対表示する

通常、コミットの日時情報はYYYY-MM-DDといった風に絶対表示されますが、--relative-dateオプションを渡すことで「〇か月前」「〇時間前」といった現在の日時に対する相対的な形式で出力することが可能です。

console

$ git log --relative-date --abbrev-commit

commit 1527aea (HEAD -> main)
Author: toriwatari <toriwatari@toriwatari.com>
Date:   3 minutes ago  # 3分前

    4th-commit

commit 0acb905
Author: toriwatari <toriwatari@toriwatari.com>
Date:   6 days ago     # 6日前

    3rd commit

commit 77e12e9
Author: toriwatari <toriwatari@toriwatari.com>
Date:   5 months ago   # 5か月前

    2nd commit

`--merge`と`--no-merge`でマージ関係

--mergesでマージコミットのみ、--no-mergesでマージコミットを除外してログを出力します。

console

$ git log --graph --all --oneline

*   ba08362 (HEAD -> develop, main) Merge branch 'develop'
|\
| * fa906d1 dev commit
* | be5f689 main commit
|/
* 4f4d558 initial commit

# マージコミットのみ
$ git log --merges --oneline
ba08362 (HEAD -> develop, main) Merge branch 'develop'

# マージコミットを除外
$ git log --no-merges --oneline

be5f689 main commit
fa906d1 dev commit
4f4d558 initial commit

`--Author`と`--Committer`

これはそのまま、--author="〇〇"、--committer="〇〇"の形で記述できます。

console

$ git log --author="alien"

commit 9061b6e9231fac0baf0b8967773e26b66517e6ca
Author: alien <alien@andromeda.space> # Author
Date:   Fri Mar 6 16:25:04 2020 +0900

    私は宇宙人だ

# Committerを確認する場合は、fullerオプションを付けてください。
$ git log --committer="toriwatari" --format="fuller"

commit c85203de19d282266cdcfe73f800a66a49486e66 (HEAD -> main)
Author:     toriwatari <toriwatari@toriwatari.com>
AuthorDate: Fri Mar 6 16:27:08 2020 +0900
Commit:     toriwatari <toriwatari@toriwatari.com> # Committer
CommitDate: Fri Mar 6 16:27:08 2020 +0900

    create index.html

コミット履歴の作り直し

さて、ここからは別のリポジトリを使って解説します。以下のコマンドを順に実行すれば、リポジトリを再現できます。

まずはscript.jsを作成、以下の内容を記述します。

const func = (str)=> {
  console.log(str);
};

let message = "Hello World";

func(message);

このscript.jsをコミットします。

$ git add .

$ git comm-t -m "func関数を作成";

次に、message変数の宣言文を、letからconstに変更します。

...(略)

const message = "Hello World";

...(略)

これもコミットします。

$ git add .

$ git commit -m "letからconstに変更"

`-S`で特定の文字列の変更で絞る

-Sオプションの後に任意の文字列を渡すことで、ファイルの中身を参照し、任意の文字列が記述された／削除されたコミットに絞って出力させることができます。--grepオプションはコミットメッセージの検索でした。-Sオプションはファイルの中身を見るという違いがあります。

例えばgit log -S messageとすると、「messageって変数名っていつ記述されたんだっけ？」を調べることができます。

$ git log --oneline -S message

b7a09d0 (HEAD -> master) func関数を作成

この-Sオプションは、変更内容を確認する-p（前回勉強しましたね）と一緒に渡すと、具体的にどんな変更があったかを確認できるのでより効果的です。

$ git log --oneline -S message -p

fa964e3 func関数を作成
diff --git a/script.js b/script.js
new file mode 100644
index 0000000..ea8a27a
--- /dev/null
+++ b/script.js
@@ -0,0 +1,7 @@
+const func = (str) => {
+    console.log(str);
+};
+
+let message = "Hello World";
+
+func(message);
\ No newline at end of file

続けて、messageを削除してみましょう。

// この行を削除してください。
const message = "Hello World";

コミットします。


$ git add .

$ git commit -m "変数を削除"

下記の通り、messageが削除されたコミットも出力されています。

$ git log --oneline -S message

83130f1 (HEAD -> master) 変数を削除
fa964e3 func関数を作成

$ git log --oneline -S message -p

83130f1 (HEAD -> master) 変数を削除
diff --git a/script.js b/script.js
index aa50b5e..30ca481 100644
--- a/script.js
+++ b/script.js
@@ -2,6 +2,4 @@ const func = (str) => {
     console.log(str);
 };

-const message = "Hello World";

 func(message);
\ No newline at end of file

fa964e3 func関数を作成
diff --git a/script.js b/script.js
new file mode 100644
index 0000000..ea8a27a
--- /dev/null
+++ b/script.js
@@ -0,0 +1,7 @@
+const func = (str) => {
+    console.log(str);
+};
+
+let message = "Hello World";
+
+func(message);
\ No newline at end of file

`-G`というオプションもある

実は、-Sと似た-Gというオプションもあります。このオプションもファイルの中身を確認してコミットを絞ります。

例えば、git log --oneline -G letとしてみましょう。letが追加された最初のコミット、letからconstに変更された2番目のコミットが出力されます。

$ git log --oneline -G let

fc8313a letからconstに変更
fa964e3 func関数を作成

では、git log --oneline -G messageとしてみましょう。3行出力されます。git log --oneline -S messageとすると2行出力されますので、2番目のコミットが余分に出力されていることが分かります。この違いは何でしょうか。

$ git log --oneline -G message

83130f1 (HEAD -> master) 変数を削除
fc8313a letからconstに変更
fa964e3 func関数を作成

# -Sだと2番目のコミットは出力されない
$ git log --oneline -S message

83130f1 (HEAD -> master) 変数を削除
fa964e3 func関数を作成

2つのオプションの特徴をより厳密に言語化します。-Sは任意の文字列が追加/削除されたコミットを出力します（前述しています）。

2番目のコミットはletからconstに宣言文が変わりましたが、messageという文字列に変化はありませんね。そのため出力対象外です。

対して-Gオプションは、変更行の中に任意のメッセージが含まれているコミットを出力します。2番目のコミットは（何度も書きますが）letからconstに宣言文が代わり、Gitはこの1行を変更行だと見做します。そして、その行の中にmessageという文字列があるため、-Gを付けるとこのコミットが出力されます。

messageという文字列自体の追加／削除を検知するのではなく、変更行の中にmessageがあるかどうかで判断します。

まとめ

オプション名	出力
-n	出力数を絞る
—	ファイルパスで絞る
—diff-filter	変更内容で絞る
—since, —until	特定の日付以降または以前で絞る
—relative-date	日付を相対表示する
—merge,—no-merge	でマージ関係
—author、—committer	Author、Committerで絞る
-S	ファイルの内容で絞る

それにしても、オプションはかなりの種類がありますね。前編と中編で結構な数のオプションを紹介しましたが、これでも全体の一部に過ぎません。

リファレンスを見ると鬼のような数のオプションが載っているのですが、上手く動かなかったりそもそも意味が分からないような物もありました（私の理解度の問題かもしれませんが）。自分で理解して説明できる気がしなかったので、この辺りで終了します。

といいつつ、まだ後編が残っていますのでぜひ読んでみてください。

鳥に生まれることができなかった人へ

#3 git logでコミット履歴を見る(中編)

git logのオプション（中編）

リポジトリーの再現

`-n <number>`でコミット数を絞る

`--grep`でコミットメッセージで検索する

ORとAND

`-- <path>`で特定のファイルの履歴を確認する

あれ？index.htmlが引っかからないけど

パスの前に`--`を付けるのはどんな時？

`--diff-filter`で変更内容でコミットを絞る

`--since`と`--until`で日付で絞る

`--relative-date`で日付を相対表示する

`--merge`と`--no-merge`でマージ関係

`--Author`と`--Committer`

コミット履歴の作り直し

`-S`で特定の文字列の変更で絞る

`-G`というオプションもある

まとめ

参考

#3 git logでコミット履歴を見る(中編)

git logのオプション（中編）

リポジトリーの再現

-n <number>でコミット数を絞る

--grepでコミットメッセージで検索する

ORとAND

-- <path>で特定のファイルの履歴を確認する

あれ？index.htmlが引っかからないけど

パスの前に--を付けるのはどんな時？

--diff-filterで変更内容でコミットを絞る

--sinceと--untilで日付で絞る

--relative-dateで日付を相対表示する

--mergeと--no-mergeでマージ関係

--Authorと--Committer

コミット履歴の作り直し

-Sで特定の文字列の変更で絞る

-Gというオプションもある

まとめ

参考

`-n <number>`でコミット数を絞る

`--grep`でコミットメッセージで検索する

`-- <path>`で特定のファイルの履歴を確認する

パスの前に`--`を付けるのはどんな時？

`--diff-filter`で変更内容でコミットを絞る

`--since`と`--until`で日付で絞る

`--relative-date`で日付を相対表示する

`--merge`と`--no-merge`でマージ関係

`--Author`と`--Committer`

`-S`で特定の文字列の変更で絞る

`-G`というオプションもある