.editorconfig の書き方

3779 ワード
EditorConfig EditorConfig テキストリンク

.editorconfig とは？

  • 主にプログラミング言語向けの、テキストファイルのレイアウトを統一するための設定ファイルです
  • テキストファイルを編集・保存する際にインデントや改行コードを設定したものに統一してくれます
  • エディタ自身が対応しているものや、プラグインで対応しているものがあります

使い方

  • 設定を適用したいフォルダに .editorconfig というファイル名でファイルを作成する
  • 下記の設定をファイルに記述する

記述方法

  • 対象とするファイルのパターンを記述し、その続きの行に設定を記述する
root = true

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

ファイルパターン

パターン 対象
[*] 全てのファイル
[*.md] 特定の拡張子のファイル
[*.{less,css,scala}] 複数の拡張子のファイル
[Makefile] 特定のファイル名のファイル

設定項目

項目 内容 値
charset 文字コード latin1, utf-8, utf-8-bom, utf-16be, utf-16le
end_of_line 改行コード cr, lf, crlf
insert_final_newline ファイル末尾に空行を挿入するか true
indent_size インデントのサイズ 2, 4, 8
indent_style インデントはタブかスペースか space, tab
trim_trailing_whitespace 行末尾のホワイトスペース（空白文字）を削除するかどうか true, false

プラグイン

エディタ プラグイン
Atom EditorConfig

参考資料