EditorConfigを利用してコーディングスタイルを統一する方法

✏️️ 2019/08/13 👍️2019/08/29 🔗

.editorconfigとは、さまざまなエディターやIDEにまたがって同じプロジェクトに取り組んでいる複数の開発者のコーディングスタイルを統一するための設定です。

プロジェクトのルートディレクトリに.editorconfigを作成すると開発者のコーディングスタイルを統一するのに役立ちます。

EditorConfig

対応エディタ

EditorConfigは、VisualStudioやRubyMineなど数多くのエディタに対応しています。
対応していないエディタを利用する場合はpluginをインストールする必要があります。

対応エディタリスト

.editorconfigを作成

touch .editorconfig

Sample

#  .editorconfig
root = true

[*]
indent_style = space
indent_size = 2
charset = utf-8
trim_trailing_whitespace = true
end_of_line = lf
  • root = true: トップEditorConfig fileであることを示します。
  • indent_style: tabまたはspaceに設定します。
  • charset: latin1、utf-8、utf-8-bom、utf-16be、またはutf-16leに設定します。
  • trim_trailing_whitespace: 改行文字の前にある空白文字を削除するにはtrueに設定します。
  • end_of_line: lf、cr、またはcrlfに設定します。

参考

Akito
日本のスタートアップで主にRuby on Railsを使ってプロダクト開発をしています。