【エディターコンフィグ】
EditorConfig とは?
最終更新:
💡 VS CodeでもVimでも、コードのお作法をそろえる
エディターやIDEの種類が違っても、インデントや改行コードなどのコーディングスタイルをそろえるための設定ファイルの形式と、それを読むエディター用プラグインの集まり。
📌 このページのポイント
- .editorconfigファイルをプロジェクトに置くと、対応したエディターがインデント幅や改行コードをその設定に合わせる
- IntelliJ、Vim、Emacs、Visual Studioなどは標準で対応。VS CodeやSublime Textなどはプラグインを入れて使う
- ファイル名のパターンごとに設定を分けられるので、JavaScriptは2スペース、Pythonは4スペースといった使い分けができる
- 決められるのはインデントや改行コード、文字コード、行末の空白などの基本的な項目
チームメンバーとインデントが合わなくて困ってるんだけど...
それはEditorConfigの出番だね。.editorconfigというファイルをプロジェクトに置くと、対応したエディターがそれを読んで、インデント幅や改行コードを設定に合わせてくれるよ。エディターが違っても同じ設定を共有できるのがポイントなんだ
VS Codeだと何か入れる必要ある?
設定って難しくない?
シンプルだよ。INI形式で、たとえば indent_style = space、indent_size = 2 のように書くんだ。[*.py] のようにファイル名のパターンを見出しにすると、その種類のファイルだけに効く設定を書けるよ。指定できるのは、インデント、改行コード(end_of_line)、文字コード(charset)、行末の空白の削除、ファイル末尾の改行などだね
フォルダーがたくさんあるときは、どの.editorconfigが使われるの?
開いたファイルのあるフォルダーから、親フォルダーへと順にさかのぼって.editorconfigを探すよ。「root = true」と書いたファイルが見つかるか、一番上のフォルダーに着いたら、そこで探すのをやめるんだ。だからプロジェクトの一番上に置くファイルには root = true を書いておくと、プロジェクトの外にある設定の影響を受けずに済むよ
まとめ:ざっくりこれだけ覚えればOK!
「EditorConfig」って出てきたら「どのエディターでもスタイルを揃える設定ファイル」と思えればだいたいOK!
📖 おまけ:英語の意味
「EditorConfig」 = エディター設定
💬 Editor(エディター)とConfig(設定)を組み合わせた名前だよ