EditorConfig ジェネレーター

.editorconfig の役割

プロジェクトのルートに置いた .editorconfig というファイルは、書式の規約を宣言します。EditorConfig に対応したエディタ（主要な IDE と最近のほとんどのテキストエディタ）は、ファイルを開いたときにそのルールを適用します。探索は編集中のファイルからディレクトリツリーを上へたどり、root = true と書かれた最初のファイルで止まります。

出力例

既定の設定（スペース、インデント幅 4、LF、utf-8）と、あらかじめチェックされている 2 つのセクションでは、次のように生成されます。

root = true

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

[*.{md,markdown}]
trim_trailing_whitespace = false

[{Makefile,makefile,GNUmakefile,*.mk}]
indent_style = tab

Python、Go、YAML にチェックを入れると、それぞれのセクションが下に追加され、その言語のフォーマッターが強制する慣習がすでに書き込まれた状態になります。

主なディレクティブ

スタイルの好みではなく、ビルドを壊す 3 つのルール

.editorconfig の項目の多くは好みの問題です。しかし次の 3 つは違います。言語ごとのセクションを用意する価値があるのは、この 3 つがあるからです。

• YAML はインデントにタブ文字を使えません。 リンターの警告ではなく、構文エラーです。タブでインデントしているプロジェクトで GitHub Actions のワークフロー、Docker Compose のファイル、Kubernetes のマニフェストを扱っているなら、YAML のセクションでスペースに戻す必要があります。
• make はレシピ行の先頭に本物のタブを必要とします。 スペースだと missing separator. Stop. と表示され、ビルドが止まります。[{Makefile,makefile,GNUmakefile,*.mk}] が複数の綴りを並べているのはこのためです。EditorConfig はファイル名を大文字と小文字を区別して照合しますが、リポジトリには Makefile と makefile の両方が存在するからです。
• CRLF で保存されたシェルスクリプトは実行できません。 カーネルが復帰文字をインタプリタのパスの一部として読み取り、/bin/bash^M: bad interpreter: No such file or directory のように表示します。Windows のバッチファイルには逆向きの問題があります。cmd.exe は goto や call :label の移動先をバイト位置で探すため、LF だけの .bat は違う行へ飛んだり、エラーも出さずに途中で止まったりします。

このうち 2 つは、全体のブロックで解決するどころか、全体のブロックが原因で起きることがあります。このジェネレーターがそこを見張っているのはそのためです。タブを選んで YAML のセクションを追加しなかった場合、あるいは CRLF を選んでシェルスクリプトのセクションを追加しなかった場合、書き出されたファイルは、そこに名前すら出てこないファイルを壊します。パイプラインが落ちてから気づくことにならないよう、ジェネレーターは出力の上でその点を伝えます。utf-16 系の文字コードも同じです。プロジェクト内のすべてのファイルに適用されますが、make、シェルのインタプリタ、Python は、その文字コードで保存されたソースを読めません。

このジェネレーターが書き出す言語ごとの慣習

この表に入っていないものに注目してください。行の長さです。PEP 8 は 79、Black は 88、PSR-12 は緩い上限として 120、rustfmt は 100 を挙げています。どれかを言語ごとのセクションに書き込むと、プロジェクト全体に対して選んだ上限を知らないうちに上書きしてしまいます。そのためジェネレーターは max_line_length を [*] ブロックだけに残し、これらの数値はこのページに載せています。必要だと判断したときに、自分で適用してください。

お使いのエディタは対応していますか？

ネイティブ対応：VS Code、JetBrains の IntelliJ 系、Visual Studio、Sublime Text、Xcode、Notepad++。Vim、Emacs、Neovim などは小さなプラグインが必要です。ファイルは単純な INI 形式なので、リンターやフォーマッターからも読み取れます。Prettier や一部の言語サーバーが歩調を合わせられるのはこのためです。