Open hysryt opened 3 years ago
チーム内でエディタの設定を共有するための仕組み。
設定は .editorconfig
という名前のファイルに記述する。
エディタは .editorconfig
を読み込み各種設定を適用する。
エディタ自体が .editorconfig
に対応している場合もあるが、多くはエディタ自体ではなく各エディタ用に用意されたプラグインがその役割を担っている。
.editorconfig
例# EditorConfig is awesome: https://EditorConfig.org
# top-most EditorConfig file
root = true
[*]
indent_style = tab
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
key | value | 説明 |
---|---|---|
indent_style |
・tab ・ space |
インデントにタブを使うかスペースを使うか。 |
indent_size |
・整数値 ・ tab |
インデント幅。tab の場合は tab_width の値が使用される。 |
tab_width |
・整数値 | タブ幅。デフォルトは indent_size の値が使用される。 |
end_of_line |
・lf ・ cr ・ crlf |
改行コード。 |
charset |
・latin1 ・ utf-8 ・ utf-8-bom ・ utf-16be ・ utf-16le |
文字コード。utf-8-bom は推奨されていない。 |
trim_trailing_whitespace |
・true ・ false |
保存時、行末の空白文字を削除するかどうか。true にすると削除。 |
insert_final_newline |
・true ・ false |
保存時、ファイル末尾に空行を追加するかどうか。true にすると追加。 |
root |
・true ・ false |
このファイルがルートの .editorconfig かどうか。false の場合、ディレクトリを遡って .editorconfig を探しに行く。一番最初に設定する必要がある。 |
https://editorconfig.org/