【Flutter開発Tips】自動生成ファイルの diff をプルリクに表示しないようにする

やりたいこと

freezed や json_serializable 、flutter_gen など、Flutter には便利な code generator がたくさんあり、私自身も愛用させていただいています。

そんな便利なコード生成ツールですが、生成されたファイルの記述量が多く、プルリクの diff を見る時にちょっぴり邪魔だったりします。

ignore するべきファイルでも無いと思うので、縮小した形で表示出来れば嬉しいですね。

解決策

.gitattributes ファイルをプロジェクトのルートに配置し、非表示にしたいファイルを記述する。

.gitattributes

# *<自動生成ファイルの拡張子> linguist-generated=true
*.freezed.dart linguist-generated=true
*.g.dart linguist-generated=true
*.gen.dart linguist-generated=true
*.gr.dart linguist-generated=true

こうすることで、自動生成ファイルの diff が表示されなくなりました 🎉

生成ファイルの内部をチェックすることはあまり無いとは思いますが、Load diff を押せば一応内部の変更も見れるので便利ですね。

どなたかの助けになれば幸いです。

参考

やまたつさんのツイートでこの存在を知りました！
便利な知見をありがとうございます！🙌

https://docs.github.com/en/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github