このツールについて
.editorconfig ファイルは、プロジェクトの貢献者が使うあらゆるエディター・IDE(VS Code、JetBrains、Vim など、多くはプラグイン不要でネイティブに読み込み)でインデント・改行コード・文字コードを統一します。グローバルな既定値を設定し、プロジェクトに必要な言語別設定にチェックを入れ(Markdown は行末の2つの空白が改行を意味するため末尾空白削除をスキップ、Makefile は実際のタブが必須)、結果をコピーまたはダウンロードします。
すべて選択したオプションからローカルで生成され、何もアップロードされません。ファイルをリポジトリのルート、.git の隣に置いてコミットしてください。それ以降、配下の全ファイルにエディターが自動的に適用します。
よくある質問
.editorconfig ファイルは実際に何をしますか?
これを読み取るすべてのエディターや IDE(VS Code、JetBrains、Vim、Sublime など、多くはネイティブ対応)に、そのフォルダーおよびその配下のファイルで使うインデント・改行コード・文字コードを伝えます。誰も手動で自分の設定をいじらなくても、貢献者がどのエディターで開いてもプロジェクトが一貫した状態を保てます。
なぜ Markdown は行末の空白削除をスキップするのですか?
標準の Markdown では、行末の2つ以上の空白がレンダリング結果で強制的に改行を生みます——意図的ですが見落としやすい構文です。行末空白削除をグローバルに適用すると、誰かがファイルを保存するたびにその書式が静かに消えてしまうため、このジェネレーターの Markdown 用設定は .md ファイルに限ってこのルールをオフにしています。
このファイルを読むのにエディターのプラグインは必要ですか?
通常は不要です。VS Code、JetBrains 系 IDE(WebStorm、PyCharm、IntelliJ など)や他の多くのエディターは .editorconfig をそのままネイティブにサポートしています。一部の古い、またはあまり一般的でないエディターは小さなプラグインが必要な場合があります——ファイルを追加しても書式が変わらないようなら、お使いのエディターのドキュメントを確認してください。ただし、多くの貢献者が使う主流のエディターではそのまま動作します。
これを使うとプロジェクト設定はどこかにアップロードされますか?
いいえ。このファイルはあなたが選んだチェックボックスとドロップダウンだけからブラウザ内で組み立てられます——そもそもプロジェクトファイルを読み込むことがないため、アップロードするものは何もありません。結果をコピーするか、直接ダウンロードしてください。