基本
基本レイアウト
プロジェクトのルートディレクトリに.editorconfigという名前のファイルを作成します。ファイルの中身は以下のような形になります。
root = true
[<ファイル名>]
<キー> = <値>
先頭行に「root = true」を入れることで、.editorconfigファイルが置かれたディレクトリ配下のファイルにのみ適用させることができます。
ファイル名の指定
その下に、「[<ファイル名>]」でルールを適用させるファイル名を指定します。ファイル名には以下のワイルドカードが使用できます。
| ワイルドカード | 説明 |
|---|---|
| * | パスのセパレータ（/）以外の文字列 |
| ** | あらゆるの文字列 |
| ? | あらゆる1文字 |
| [name] | 括弧内のいずれか1文字 |
| [!name] | 括弧内に含まれない1文字 |
| {s1,s2,s3} | カンマで区切られた文字列のうち一つ |
| {num1..num2} | num1からnum2の間にあるすべての整数値 |
ルールの指定
その下に「<キー> = <値>」の形式で適用させるルールを指定します。
| キー | 値 | 説明 |
|---|---|---|
| indent_style | tab space | インデントのスタイル（タブかスペース） |
| indent_size | 整数値 | インデントのサイズ |
| tab_width | 整数値 | タブの幅 |
| end_of_line | lf cr crlf | 改行コード |
| carset | latin1 utf-8 utf-8-bom utf-16be utf-16le | 文字コード |
| trim_trailing_whitespace | true false | 改行コードの前のスペースを削除するかどうか |
| insert_final_newline | true false | 最終行に空行を入れるかどうか |
例
root = true
[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
[*.java]
indent_size = 4