GitHub の Pull Request で出ている差分のスペースやタブを無視して見やすくする方法

はじめに

GitHub で, インデントをズラしたり大幅に構成を変えた Pull Request を出した際に, そんなに修正したつもりはないのに大幅に差分が出てしまうことってありませんか？

もしかしたら, その差分のほとんどがスペースやタブかもしれません.
今回はその差分の原因かもしれないスペースやタブのみを無視した差分を表示する方法を紹介します.

Pull Request のスペースやタブの差分を無視する方法

まず, GitHub の pull request にアクセスします.
その後, Files changed タブを選択します.

スペースによる差分が多いとこんな感じで上下に差分のマイナスとプラスの塊が表示されてることが多いです.

この差分を見やすくするには, 歯車アイコンをクリックして Hide whitespace changes にチェックを入れて Apply and reload ボタンを押して画面をリロードします.

こうすると, あれほどあった差分が以下のようにスペースとタブの差分が無視されて修正した箇所がわかりやすくなります.

２つの差分の画像は全く同じファイルの同じ箇所の差分を表示しています.
行数も半分以下になり, 明確に修正箇所だけ diff が当たっているのがわかると思います.

ちなみにですが今回やったのは実は URL のクエリに w=1 をくっつけてるだけなので, 自分で URL に直接 ?w=1 をつけたり, 以下のようなブックマークレットを作って実行することでも簡単に実現できます.

bookmarklet

javascript:location.href=location.href+'?w=1';

残念ながらデフォルト値として w=1 を付ける方法は今の所ないみたいです.

スペースやタブが差分として重要なケースもあると思うので, w=1 を付けるかどうかは都度判断しましょう!

おわりに

これもメンバーが入ってくるたびに都度教えてる気がするので Zenn のエントリーとしてストックさせていただきました.

ぜひ Pull Request で差分が多いときに試してみてください.

場合によっては, メンバーに Pull Request のレビューを依頼するときに予め w=1 を付けてメッセージを送ってあげると親切かもしれませんね.

https://github.com/<user name>/<project name>/pull/1/files?w=1

レビューの精度が上がってお互いに楽になるかもしれません.