【エディターコンフィグ】

EditorConfig とは?

公開:
💡 VS CodeでもVimでも、コードのお作法をピシッと統一
📌 このページのポイント
EditorConfig: エディター間のスタイル統一 .editorconfig indent_style = space indent_size = 2 end_of_line = lf VS Code 2スペース / LF IntelliJ 2スペース / LF Vim 2スペース / LF 全員同じスタイルで統一!
EditorConfigによるスタイル統一のイメージ
ひよこ ひよこ
チームメンバーとインデントが合わなくて困ってるんだけど...
ペンギン先生 ペンギン先生
それはEditorConfigの出番だね。.editorconfigというファイルをプロジェクトのルートに置くだけで、誰がどのエディターを使っていてもインデント幅や改行コードが統一されるよ
ひよこ ひよこ
Prettierフォーマットすれば同じことじゃない?
ペンギン先生 ペンギン先生
PrettierJavaScriptCSSなど対応言語のフォーマットだけど、EditorConfigはMakefileやYAMLなどPrettierが対象にしない言語にも効くんだ。両方使うのがベストだよ
ひよこ ひよこ
設定って難しくない?
ペンギン先生 ペンギン先生
すごくシンプルだよ。たとえばindent_style = space、indent_size = 2 と書くだけ。INI形式で直感的に読み書きできるんだ
ひよこ ひよこ
VS Codeだと何か入れる必要ある?
ペンギン先生 ペンギン先生
VS Codeの場合はEditorConfig拡張をインストールするだけだよ。IntelliJやWebStormは標準で対応しているから追加インストールも不要なんだ
ひよこ ひよこ
ぶっちゃけ、どのくらいのプロジェクトで使われてるの?
ペンギン先生 ペンギン先生
GitHubの人気リポジトリを見ると、かなりの割合で.editorconfigが置いてあるよ。設定コストがほぼゼロなのにチーム全体のストレスを減らせるから、入れない理由がないんだよね
ペンギン
まとめ:ざっくりこれだけ覚えればOK!
「EditorConfig」って出てきたら「どのエディターでもスタイルを揃える設定ファイル」と思えればだいたいOK!
📖 おまけ:英語の意味
「EditorConfig」 = エディター設定
💬 Editor(エディター)とConfig(設定)を組み合わせたそのままの名前だよ。シンプルな名前だけど、やることもシンプルで分かりやすいんだ
← 用語集にもどる