EditorConfig-Generator
Erstelle eine .editorconfig-Datei, die Einrückung, Zeilenenden und Leerzeichen in allen Editoren deines Teams einheitlich hält. Starte mit einer Sprachvorlage, passe jedes Dateimuster an und teste vor dem Commit, welche Regeln für einen beliebigen Pfad gelten.
Zuletzt aktualisiert:
Abschnitte
.editorconfig
Speichere sie als .editorconfig (mit führendem Punkt) im Stammverzeichnis deines Projekts. Entfernt dein Browser beim Herunterladen den Punkt, benenne die Datei um.
Anleitung: EditorConfig-Generator
- Wähle eine Vorlage für deine Hauptsprache und klicke auf Vorlage laden oder importiere eine vorhandene .editorconfig.
- Bearbeite die Abschnitte: Ändere das Dateimuster in eckigen Klammern und wähle Werte für jede Eigenschaft. Lass eine Eigenschaft auf (nicht gesetzt), um die Standardeinstellung des Editors zu behalten.
- Füge Abschnitte für spezielle Dateien mit den Schnellschaltflächen hinzu, zum Beispiel für Makefiles, die Tabs brauchen, oder Markdown, das abschließende Leerzeichen behält.
- Teste einen Pfad wie
src/app.ts, um die passenden Abschnitte und die Einstellungen zu sehen, die ein Editor verwendet. - Kopiere oder lade die Datei herunter und speichere sie als
.editorconfigim Stammverzeichnis deines Projekts.
Übersicht der EditorConfig-Eigenschaften
| Eigenschaft | Werte | Was sie steuert |
|---|---|---|
root | true | Nur am Dateianfang (außerhalb jedes Abschnitts): Suche nach .editorconfig-Dateien in übergeordneten Ordnern beenden. |
indent_style | space oder tab | Ob die Tabulatortaste und die automatische Einrückung Leerzeichen oder Tabulatorzeichen einfügen. |
indent_size | ganze Zahl, tab | Spalten pro Einrückungsebene. |
tab_width | ganze Zahl | Anzeigebreite eines Tabulatorzeichens; standardmäßig gleich indent_size. |
end_of_line | lf, crlf oder cr | Zeilenumbruch, der beim Speichern geschrieben wird: LF für Unix/macOS, CRLF für Windows. |
charset | utf-8, utf-8-bom, latin1, utf-16be oder utf-16le | Dateikodierung. Verwende utf-8, außer ein Tool braucht ein BOM. |
trim_trailing_whitespace | true oder false | Leerzeichen am Zeilenende beim Speichern entfernen. |
insert_final_newline | true oder false | Sicherstellen, dass die Datei mit einem Zeilenumbruch endet. |
max_line_length | ganze Zahl, off | Hilfslinie oder Umbruchspalte; nur von manchen Editoren unterstützt. |
Jede Eigenschaft kann auch auf unset gesetzt werden, wodurch ein aus einem früheren Abschnitt geerbter Wert entfernt wird und der Editor auf seinen eigenen Standard zurückfällt. Bei Eigenschaftsnamen und Werten spielt Groß-/Kleinschreibung keine Rolle.
Spickzettel für Glob-Muster
| Muster | Passt auf |
|---|---|
* | Beliebige Zeichenfolge außer /; [*] allein passt auf jede Datei |
** | Beliebige Zeichenfolge einschließlich /, daher passt src/**.ts auf TypeScript-Dateien in jeder Tiefe unter src |
? | Genau ein Zeichen (nicht /) |
[abc] bzw. [!abc] | Ein Zeichen aus der Menge bzw. nicht aus der Menge |
{js,ts,tsx} | Eine der kommagetrennten Alternativen, z. B. *.{js,ts,tsx} |
{1..5} | Jede ganze Zahl von 1 bis 5, z. B. chapter{1..5}.md |
Kombiniere EditorConfig mit einem Formatierer für volle Einheitlichkeit: Der Prettier-Config-Generator erstellt eine passende .prettierrc, und Prettier liest indent_style, indent_size/tab_width, max_line_length und end_of_line aus der .editorconfig, wenn sie nicht in der eigenen Konfiguration gesetzt sind.
Häufige Fragen
Was ist eine .editorconfig-Datei?
Es ist eine kleine Textdatei im INI-Stil, die Code-Editoren mitteilt, wie Dateien in einem Projekt formatiert werden sollen: Leerzeichen oder Tabs, Einrückungsbreite, Zeilenenden, Zeichensatz und Entfernen von Leerzeichen. Viele Editoren lesen sie nativ (JetBrains-IDEs, Visual Studio, Vim, Neovim, der Web-Editor von GitHub), andere wie VS Code brauchen die EditorConfig-Erweiterung.
Wohin kommt die .editorconfig-Datei?
Speichere sie im Stammordner deines Repositorys und committe sie. Editoren suchen .editorconfig im Ordner der Datei und in jedem übergeordneten Ordner; root = true in der obersten Datei beendet diese Suche, sodass Einstellungen außerhalb des Projekts ignoriert werden.
Wie funktionieren Abschnitte und Muster?
Jede [Abschnitt]-Überschrift ist ein Dateimuster. Spätere Abschnitte überschreiben frühere bei den Eigenschaften, die sie setzen, also stell die [*]-Standards an den Anfang und spezifische Muster danach. Ein Muster ohne Schrägstrich wie *.md passt auf Dateien in jedem Ordner; ein Muster mit Schrägstrich wie lib/**.js ist relativ zum Ordner, der die .editorconfig enthält.
Was ist der Unterschied zwischen indent_size und tab_width?
indent_size gibt an, wie viele Spalten eine Einrückungsebene belegt. tab_width gibt an, wie breit ein Tabulatorzeichen angezeigt wird. Rückst du mit Leerzeichen ein, setzt du normalerweise nur indent_size; tab_width übernimmt standardmäßig denselben Wert. indent_size = tab bedeutet, dass eine Einrückung einem Tab mit tab_width Spalten entspricht.
Formatiert EditorConfig meine bestehenden Dateien um?
Nein. Es ändert nur, wie sich Editoren beim Tippen und Speichern verhalten: neue Einrückungen, geschriebene Zeilenenden, Entfernen abschließender Leerzeichen beim Speichern und so weiter. Bestehende Dateien behalten ihre Formatierung, bis sie bearbeitet oder durch einen Formatierer wie Prettier geschickt werden.
Wird max_line_length überall unterstützt?
Nein. max_line_length ist eine domänenspezifische Eigenschaft, die manche Editoren beachten (JetBrains-IDEs, Vim mit dem Plugin, Emacs), während andere sie ignorieren. Formatierer wie Prettier lesen sie als printWidth, wenn keine andere Einstellung angegeben ist.
Wird etwas hochgeladen?
Nein. Die Datei wird in deinem Browser erzeugt. Deine letzte Konfiguration wird nur im lokalen Speicher dieses Browsers gesichert, damit sie bei deiner Rückkehr noch da ist.
Werden alle Tools auf FreeToolCabin auf Qualität und Genauigkeit getestet?
Ja. Jedes Tool auf der Website durchläuft automatische Tests in echten Browsern, die prüfen, ob das Ergebnis stimmt und keine Fehler auftreten. Wenn du einen Fehler findest oder einen Vorschlag hast, schreib uns an [email protected] – wir sehen es uns an.