はじめに
EditorConfigを利用することで複数のテキストエディタやIDEでインデントや改行コードなどの設定を共有することができます。
設定は.editorconfig
に記述します。
この.editorconfig
の記述方法について記載します。
なおVSCodeの場合には、以下の拡張機能をインストールすることで使用可能です。
.editorconfig
の記述方法
以下のように記述します。
.editorconfig
root = true
[*]
end_of_line = lf
trim_trailing_whitespace = true
insert_final_newline = true
indent_style = space
indent_size = 2
[*.md]
trim_trailing_whitespace = false
設定できる主な項目は以下のとおりです。
設定名 | 説明 |
---|---|
[...] | 対象ファイルを指定。 |
root | trueにすることで.editorconfig 以下のディレクトリに設定を適用する。 |
end_of_line | 改行コードを指定する。lf ,cr ,crlf から選択。 |
indent_style | ハードタブかソフトタブかを指定。tab , space から選択。 |
indent_size | インデントのサイズを指定。2 , 4 から選択。 |
charset | 文字コードを指定。latin1 , utf-8 , utf-8-bom , utf-16be , utf-16le から選択。 |
tab_width | タブの幅を指定する。省略するとindent_sizeが適用される。 |
trim_trailing_whitespace | 行末の空白を削除。 |
insert_final_newline | ファイルの末尾が改行ではない場合に補完。 |