勘に頼らず.editorconfigを書く

インデント方式・幅・改行コード・文字コードを選ぶと、主要セクションを埋めた有効な.editorconfigができます。

このガイドで使う道具

やりたいこと

EditorConfigは混在するエディタのインデントと改行コードを揃えます。形式は簡単ですがプロパティ名は打ち間違えやすいので、正しい雛形を生成して拡張できます。

規約を選ぶ

インデント方式(スペース/タブ)・幅・行末・文字コード・行末空白除去・最終改行を選びます。生成してダウンロードかコピーできます。

  • root=trueで親設定の探索を止めます。リポジトリのルートに置きます。
  • 例外オプションを有効にすると2つのよくある例外を付けます。行末空白除去を外す[*.md]セクションと、タブを強制するMakefileセクションです。

具体例

スペース・4・LF・UTF-8・空白除去・最終改行を選ぶと[*]に6行のファイルができます。例外を有効にすると[*.md]と[{Makefile,makefile}]の上書きセクションが続きます。

対応範囲

妥当な初期ファイルを生成するだけです。リポジトリの既存スタイル検出や既存.editorconfigとのマージはしません。出力は標準コアプロパティのみで、プラグイン固有キーは含みません。