EditorConfig テスター

使い方

1. 1つ目の入力欄に .editorconfig を貼り付けます。複数ある場合は「# path: vendor/.editorconfig」のような目印の行で区切り、プロジェクトルートのファイルを先頭に置きます。
2. 2つ目の入力欄に判定したいパスを1行に1つ書きます。最上位の .editorconfig があるプロジェクトルートからの相対パスです。
3. パスごとの表を読みます。プロパティ、最終的な値、そしてそれを設定したファイル・行・セクションのグロブが並びます。導出値と書かれた行はどのファイルにも書かれておらず、どの規則で生まれたかが併記されます。
4. 表の上の探索順序を確認します。近い順に参照した .editorconfig と、root = true で止まったのか、プロジェクトより上へ続くのかが分かります。
5. 指摘パネルを順に見ます。死んだセクション、決して勝たない設定、波かっこ内の空白など、見た目どおりに動かない箇所をファイルと行番号で示します。

よくある質問

[*] に2と書いたのに、なぜ半角4つになるのですか。

後ろにある設定か、より近い設定が勝ったからです。EditorConfig には CSS のような詳細度がありません。1つのファイルの中では最後に一致したセクションが勝つので、[*] ブロックの20行下にある [*.py] ブロックが静かに上書きします。同じ名前の [*] がもう一度出てくる場合も同じで、だからセクション名の重複が問題になります。ファイル同士ではプロパティごとに最も近い .editorconfig が勝つため、編集中のディレクトリにある2行の設定が、ルートの丁寧な設定に勝ちます。順序と距離がすべてで、「設定した場所」の列が値を生んだファイル・行・セクションのグロブと、それが退けた設定まで示します。

[*.js]、[lib/*.js]、[**/*.js] は何が違うのですか。

違いはスラッシュの有無だけです。スラッシュを含まないグロブは深さに関係なくファイル名だけを見るので、[*.js] は src/a.js も vendor/dist/b.js も対象にします。末尾以外にスラッシュが1つでもあると、その .editorconfig のディレクトリに固定され、[lib/*.js] は lib/a.js だけに一致し、lib/sub/a.js にも src/lib/a.js にも一致しません。[**/*.js] は固定されつつディレクトリを越える形です。* はスラッシュで止まりますが ** は越え、途中の /**/ はディレクトリが1つもない場合も表すので、a.js と lib/sub/a.js の両方に一致します。最後の落とし穴として、[lib/] のように末尾がスラッシュのグロブは何にも一致しません。ファイルパスはスラッシュで終わらないからで、配下全体は [lib/**] と書きます。

書いた覚えのない indent_size = tab や tab_width はどこから来たのですか。

統合後にコアが適用する補完規則からです。indent_style が tab で indent_size が未設定なら indent_size は tab になります。indent_size が数値で tab_width が未設定なら tab_width がその値を複製するので、indent_size しか書いていないファイルでも tab_width が併せて報告されます。逆に indent_size が tab で tab_width があれば、indent_size がその数値を受け取ります。統合結果に対して働くため、2つの断片が別々のファイル由来になることがあります。unset も同じ経路を通るので、indent_size = unset なら tab_width も unset になります。

root = true は具体的に何を止めるのですか。

.editorconfig をさらに探しに上へ行く動きを止めます。この行がないと探索はプロジェクトで終わらず、親ディレクトリ、ホームディレクトリ、ファイルシステムのルートまで続き、そこで見つかった設定が自分のファイルで決めなかったプロパティを埋めます。効かせるには2点が必要です。最初のセクション見出しより前、つまり冒頭に置くこと。[*] ブロックの中に書くと root という名前の普通のプロパティにすぎず、何も止めません。またそのファイルのセクションが1つも一致しなくても root = true は読まれるので、セクションが全部外れた設定ファイルでも探索は終わります。

[*.{js, ts}] が .ts ファイルに適用されないのはなぜですか。

空白がパターンの一部だからです。波かっこの選択はカンマの間の文字列をそのまま比較し、セクション見出しでは空白の除去を一切行いません。つまり {js, ts} が示す候補は "js" と " ts" で、名前に実際に空白を含むファイルだけが2つ目に一致します。同種の落とし穴があと2つあります。カンマのない {js} は選択ではなく {js} という3文字そのものなので、[*.{js}] は app.{js} という名前のファイルにしか適用されません。また {1..10} のような数値範囲は先頭の 0 を拒むので、1.txt と 10.txt は一致し 01.txt は一致しません。

バックスラッシュで * をエスケープできますか。

文書の説明に反して、参照実装ではできません。コアはグロブを一度に正規表現へ変換しますが、エスケープが実際に効くのはカンマ、閉じ波かっこ、#、; だけです。いずれも、そのままではパターンを終わらせたり選択を区切ったりする文字です。* や ? の前のバックスラッシュは捨てられワイルドカードが残るため、[a\*b.txt] は aXb.txt にも一致します。さらに \[ と \{ は生成される正規式のかっこの対応を壊し、コンパイル自体が失敗します。エディタのプラグインはたいてい何も言わずに .editorconfig 全体を無視します。このツールは推測せずそれを再現し、該当セクションを使えないグロブとして報告します。実務的には、セクション名に波かっこ・角かっこ・アスタリスクを入れないのが正解です。

関連ツール