EditorConfigのススメ

2016/10/01

EditorConfigはコーディングスタイルを定義するためのファイルフォーマットです。

コーディングスタイルは個々の好みが出やすいので放っておくとバラバラなままで混在しがち。かと言ってコーディング規約を決めて守らせるのはなかなか大変です。

じゃあ自動的に統一されるようにすればいいじゃん、ということでEditorConfigの出番です。

EditorConfigを使えばわざわざ設定を手で直してもらう必要がなくて確実。定義ファイルは.editorconfigというテキストファイルなのでGitで管理できるのもメリットですね。 あくまでファイルフォーマットなのでエディタやIDEが対応している必要がありますが、有名どころはたいて対応しています。

設定できる主な項目はこのあたり。

  • 文字コード
  • 改行コード
  • インデントスタイル (ソフトタブ or ハードタブ)
  • インデント幅

自分の場合、普段はこんな感じにしてます。拡張子ごとに設定を変えるなど、もっと細かく制御することもできます。

root = true

[*]
end_of_line = lf
insert_final_newline = true
charset = utf-8
indent_style = space
indent_size = 2

プロジェクトを始めるときはとりあえず.editorconfigを作っておくのが安心ですね。

参考URL




おススメ