So verwenden Sie es
- Wählen Sie die Einrückung unter Einrücken mit und Einrückungsgröße. Wählen Sie den Zeilenumbruch unter Zeilenende und die Kodierung unter Zeichensatz.
- Setzen Sie die Haken bei den Abschnitten für Dateitypen, die Sie brauchen: Nachgestellte Leerzeichen in Markdown behalten, YAML mit zwei Leerzeichen einrücken und Makefile-Rezepte mit Tabulatoren einrücken.
- Kopieren Sie den Text unter Die .editorconfig-Datei oder laden Sie ihn herunter, und speichern Sie ihn im obersten Ordner Ihres Projekts.
- Lesen Sie unter Was jede Zeile bedeutet ab, was jede Eigenschaft bewirkt.
So arbeitet die Datei
Viele Editoren und IDEs lesen eine .editorconfig-Datei und wenden ihre Einstellungen auf die Dateien an, die zu jedem Abschnitt passen. Eine Abschnittsüberschrift ist ein Dateinamenmuster in eckigen Klammern, und die Eigenschaften darunter gelten für jede passende Datei. Ein späterer Abschnitt überschreibt einen früheren bei derselben Eigenschaft. Die Zeile root = true beendet die Suche, daher erreichen die Einstellungen nur diesen Ordner und die Ordner darunter.
- * passt auf beliebige Zeichen außer einem Schrägstrich.
- ** passt auf beliebige Zeichen, Schrägstriche eingeschlossen.
- {yml,yaml} passt auf beide Endungen, daher passt *.{yml,yaml} auf beide Dateiarten.
Die Abschnitte für Dateitypen
- Markdown: Zwei Leerzeichen am Ende einer Zeile ergeben einen Zeilenumbruch, daher ist das Kürzen für *.md ausgeschaltet.
- YAML: Tabulatorzeichen sind für die Einrückung nicht erlaubt, daher wird *.{yml,yaml} mit Leerzeichen eingerückt, zwei je Ebene.
- Makefile: Jede Rezeptzeile muss mit einem Tabulatorzeichen beginnen, daher erhält Makefile indent_style = tab.
Die Werte wählen
- Leerzeichen sind die übliche Wahl für Code. Tabulatoren passen zu einem Team, dessen Editoren alle einen Tabulator gleich breit anzeigen.
- LF ist der übliche Zeilenumbruch für Projekte unter Linux und macOS und in den meisten Repositorys. CRLF ist der Zeilenumbruch von Textdateien unter Windows.
- UTF-8 ist die übliche Kodierung. Verwenden Sie UTF-8 mit Byte-Order-Mark nur, wenn ein Programm sie braucht.
Rechenbeispiel: die Standardwerte
Mit Leerzeichen, einer Einrückungsgröße von 2, LF, UTF-8, entfernten Leerzeichen am Zeilenende, einem Zeilenumbruch am Dateiende und den drei Abschnitten für Dateitypen hat die Datei eine root-Zeile, einen Abschnitt für alle Dateien mit sechs Eigenschaften, je eine Eigenschaft im Abschnitt Markdown und im Abschnitt Makefile sowie zwei im Abschnitt YAML. Die Tabelle listet elf Eigenschaftszeilen, sechs davon zeigt sie hier.
| Abschnitt | Eigenschaft | Wert |
|---|---|---|
| Anfang der Datei | root | true |
| Alle Dateien | indent_style | space |
| Alle Dateien | indent_size | 2 |
| Markdown (.md) | trim_trailing_whitespace | false |
| YAML (.yml, .yaml) | indent_style | space |
| Makefile | indent_style | tab |
Häufig gestellte Fragen
Wohin gehört die .editorconfig-Datei?
In den obersten Ordner des Projekts, neben die README. Editoren suchen sie im Ordner jeder Datei und danach in jedem Ordner darüber. Die Suche endet bei der ersten Datei mit root = true.
Formatiert eine .editorconfig-Datei meinen Code neu?
Nicht von selbst. Sie sagt Editoren und Erweiterungen, welche Einrückung, Zeilenumbrüche und Kodierung sie beim Bearbeiten oder Speichern einer Datei verwenden sollen. Das Neuformatieren übernehmen ein Formatierer oder ein Linter, und manche davon lesen dieselben Einstellungen.
Warum behält der Abschnitt Markdown die nachgestellten Leerzeichen?
In Markdown ergeben zwei Leerzeichen am Ende einer Zeile einen Zeilenumbruch. Würde man sie entfernen, verschmölzen zwei Zeilen zu einer. Daher schaltet dieser Abschnitt das Kürzen nur für .md-Dateien ab.
Warum muss ein Makefile Tabulatoren verwenden?
make liest jede Rezeptzeile nach einem Tabulatorzeichen, und ein Rezept, das mit Leerzeichen beginnt, ist ein Fehler. Der Abschnitt Makefile setzt daher indent_style auf tab für Dateien mit dem Namen Makefile.
Kann ein Unterordner eine dieser Einstellungen wieder aufheben?
Ja, mit dem Wert unset, der eine früher gesetzte Eigenschaft entfernt. Diese Seite schreibt nur einfache Werte, daher tragen Sie die Zeile in der eigenen .editorconfig-Datei des Unterordners ein, wenn Sie sie brauchen.
Wird die Datei an einen Server gesendet?
Nein. Die Datei wird in Ihrem Browser aus Ihren Auswahlen geschrieben, und nichts, was Sie auswählen, wird gespeichert.
Quellen
- EditorConfig (englisch): das Dateiformat und die unterstützten Eigenschaften
- EditorConfig-Spezifikation (englisch): Abschnitte, Glob-Muster und root
- CommonMark 0.31.2 (englisch): harte Zeilenumbrüche (zwei Leerzeichen am Zeilenende)
- YAML 1.2.2 (englisch): Tabulatorzeichen dürfen nicht zur Einrückung verwendet werden
- GNU-Make-Handbuch (englisch): Eine Rezeptzeile beginnt mit einem Tabulatorzeichen
Zahlen und Text zuletzt geprüft: Dienstag, 10. November 2026.