7.6 EditorConfigを導入する

チーム開発において、開発者が使うエディタやIDE、開発するマシンのOSは、開発者の好みに委ねられる場合があります。道具を柔軟に選択して効率的な開発をすすめたい一方で、開発者の環境が異なれば、作成されるファイルに細かい違いが発生します。たとえばファイルの改行コードや文字コード、ファイルのレイアウト、空白をタブで設定するのか、スペースで設定するのか、ファイルの末尾に改行を入れる、入れない、といったものです。細かい違いによって、コードレビューのときに本質的でない差分が発生し、逆に効率が悪くなることもあります。ファイルの文字コードが異なることで文字化けしてファイルが読めない、といったことも起こり得ます。EditorConfig を導入することで、ファイルの形式やレイアウトを統一できます。Goのコードは go fmt によりフォーマットされるので影響は少ないですが、Goのテストコードで使われるCSVファイルやJSONファイル、あるいはドキュメントのマークダウンファイルなどプロジェクト開発ではGoのコード以外にも多くのファイルがコミットされます。このようなファイルの差異は EditorConfig を導入して、効率的な開発を実現しましょう。

7.6.1 EditorConfigの導入方法

「7.1  エディタとIDE 」で紹介したVisual Studio CodeやGoLandでは EditorConfig をサポートしています。その他にも多くのエディタやIDEが EditorConfig をサポートしています。多くの場合は上記の .editorconfig ファイルをリポジトリのルートに配備し、プラグインのインストールとエディタに応じた設定を行うことで導入できます。エディタごとの導入方法については割愛します。 ...