【Flutter】Githubプルリク時に特定ファイルの差分表示を閉じる

はじめに

GitHubでプルリクエストを行う際、自動生成ファイルや依存関係ファイルが多数含まれると、レビューが煩雑になりがちです。特に、Podfile.lockやpubspec.lockのようなファイルは頻繁に更新されるため、レビュアーにとってはノイズとなります。このようなファイルをプルリクエスト時に閉じた状態にするために、.gitattributesファイルを活用します。本記事では、その設定方法について説明します。

設定方法

.gitattributesファイルの作成または編集:

プロジェクトのルートディレクトリに.gitattributesファイルが存在しない場合は、新規作成します。既に存在する場合は、以下の内容を追記します。

Podfile.lock linguist-generated=true
pubspec.lock linguist-generated=true

これにより、GitHubはPodfile.lockおよびpubspec.lockを自動生成ファイルとして認識し、プルリクエスト時にデフォルトで閉じた状態にします。

余談

.gitattributesファイルを使用すると、改行コードをそろえたりできるみたいです。

参考

• Flutter激推し企業のエンジニアが語る！開発ノウハウLT大会
  上記の いせりゅーさんのLT「②Flutter開発が効率のよくなる〇選」が元ネタです。社内では自動生成ファイル用に使用しているようですが、個人的には XXX.lock に便利だと思い、使ってます！

まとめ

.gitattributesファイルを利用することで、自動生成ファイルや依存関係ファイルをGitHubのプルリクエスト時に閉じた状態にすることができます。これにより、レビューがしやすくなり、重要な変更点に集中できるようになります。是非、プロジェクトで活用してみてください。