導入：なぜコードのスタイル統一が必要なのか？
チーム開発で、誰かが書いたコードを修正しようとしたら「インデントがタブかスペースか混ざっていて差分が膨大になった」「改行コードの違いでgitの履歴が汚れてしまった」という経験はありませんか？開発者がそれぞれ好きなエディタを使う中で、こうした些細なスタイルの不一致は、コードレビューの効率を下げ、バグの温床にもなります。これらを解決し、全エディタで自動的にルールを適用してくれる魔法のファイルが「.editorconfig」です。
基礎知識：EditorConfigとは何か
.editorconfigは、プロジェクトのルートディレクトリに配置する設定ファイルです。このファイルを置くことで、VS Code、IntelliJ、Vimなど、どのエディタを使っていても、定義したコーディング規約を自動で適用できます。Linter（静的解析ツール）やFormatter（自動整形ツール）の実行前に、最低限の「インデント」や「改行」のルールを担保する、いわば「コードの健康を守る第一歩」です。
実装/解決策：プロジェクトへの導入手順
導入は非常にシンプルです。プロジェクトのルートディレクトリに「.editorconfig」という名前のファイルを作成し、設定を記述するだけです。多くのエディタは標準でこのファイルに対応していますが、VS Codeの場合は「EditorConfig for VS Code」という拡張機能をインストールしておくことをおすすめします。
サンプルプログラム：現場で使える標準的な設定
以下のコードをコピーして、プロジェクトのルートに配置してください。これが最も標準的で汎用性の高い設定例です。
すべてのファイルに適用するルール
[]
文字コードはUTF-8で統一
charset = utf-8
インデントスタイルをスペースに設定
indent_style = space
インデント幅を4スペースに設定
indent_size = 4
改行コードをLF（Linux/Mac標準）に統一
end_of_line = lf
ファイルの最後に自動で空行を挿入する
insert_final_newline = true
行末の余計な空白を削除する
trim_trailing_whitespace = true
[.md]
Markdownファイルはインデントを2スペースにする設定例
indent_size = 2
応用・注意点：現場で役立つ補足情報
注意点1：既存プロジェクトへの適用
すでにコードが大量にあるプロジェクトで導入する場合、いきなり適用するとファイル全体が変更対象となり、gitの差分が大量に発生します。導入初期は「新規作成ファイル」のみに適用する運用から始めるか、一度全ファイルを整形してコミットするタイミングをチームで相談してください。
注意点2：Linterとの使い分け
EditorConfigはあくまで「ベースとなるエディタの挙動」を揃えるものです。複雑な言語仕様のチェックや高度なコーディング規約の強制は、PrettierやESLintなどの専門ツールに任せるのが鉄則です。EditorConfigは「それらのツールが正しく動作するための土台」として活用しましょう。
コメント