【開発環境】EditorConfigで複数の開発者がエディタが異なっていてもフォーマットを揃える

複数の開発者が異なるエディタやIDEを使って同じプロジェクトで作業すると、コードのフォーマットがバラバラになりがちなので揃えたい

この問題を解決するのがEditorConfig

editorconfig.org

EditorConfigの概要

EditorConfigは、エディタごとの設定を統一するための仕組み

プロジェクトのルートディレクトリに配置する.editorconfigファイルを使って、インデントスタイル、タブやスペースの使用、改行コード、ファイルのエンコーディングなどを定義する

エディタはこのファイルを読み込み、指定された設定に従ってファイルを自動整形する

主要なエディタやIDEはEditorConfigを標準サポートしており、プラグインのインストールで対応可能なものも多い

.editorconfigファイルの構成

.editorconfigファイルはINI形式で記述し、各セクションで適用対象のファイルパターンを指定する

例えば、Pythonファイルに適用する場合は以下のように記述

[*.py]
indent_style = space
indent_size = 4
end_of_line = lf
charset = utf-8

この設定では、

• すべての.pyファイルに適用
• インデントはスペースを使用
• インデントサイズは4
• 改行コードはLF
• 文字エンコーディングはUTF-8

といったルールが適用される

複数の拡張子に適用させる場合は以下のようにする

[*.{js,jsx,ts,tsx,json,yml,yaml,md,mjs}]
indent_style = space
indent_size = 2