Gitignore-Generator
Erstelle eine .gitignore-Datei für dein Projekt, indem du die offiziellen Vorlagen von GitHub für Programmiersprachen, Frameworks, Editoren und Betriebssysteme kombinierst.
Eingabe
Ausgabe
Readme
Was ist eine .gitignore-Datei?
Eine .gitignore-Datei teilt Git mit, welche Dateien von der Versionsverwaltung ausgeschlossen werden sollen: Abhängigkeiten, die erneut installiert werden können (wie node_modules), Build-Ausgaben, Protokolle, cache, Editor-Einstellungen und Dateien, die dein Betriebssystem hinterlässt, wie .DS_Store unter macOS oder Thumbs.db unter Windows. Lege sie im Stammverzeichnis deines Repositorys ab. Ihre Muster gelten für diesen Ordner und alle darunterliegenden Ordner.
Woher die Vorlagen stammen
Die Vorlagen stammen aus der offiziellen Sammlung von GitHub, dem Repository github/gitignore – denselben Vorlagen, die GitHub beim Erstellen eines Repositorys anbietet. Das Tool lädt eine Kopie, die täglich aktualisiert wird. Die Vorlagen sind in drei Gruppen unterteilt:
- Hauptvorlagen für Sprachen, Frameworks und Tools, zum Beispiel Node, Python, Java, Go, Rust, Unity und WordPress.
- Globale Vorlagen für Editoren, Betriebssysteme und andere Tools, zum Beispiel macOS, Windows, Linux, VisualStudioCode, JetBrains und Vim. Sie eignen sich sowohl für die .gitignore-Datei eines Projekts als auch für die globale Datei, die Git auf alle deine Repositorys anwenden kann.
- Community-Vorlagen für speziellere Frameworks und Tools, die von der Community gepflegt werden, zum Beispiel JavaScript/Vue oder Python/JupyterNotebooks.
So verwendest du das Tool
- Wähle zunächst eine Schnelloption für einen gängigen Projekttyp. Dabei werden die Vorlagen für den jeweiligen Technologie-Stack sowie macOS, Windows und den üblicherweise damit verwendeten Editor ausgewählt.
- Oder suche im Feld „Vorlagen“ und wähle alle Sprachen, Frameworks, Editoren und Betriebssysteme aus, die dein Projekt verwendet. Deaktiviere eine Vorlage oder drücke im Feld die Rücktaste, um sie wieder zu entfernen.
- Die .gitignore-Datei wird während deiner Auswahl erstellt. Jede Vorlage erhält einen eigenen Kommentar als Überschrift und wird in der Reihenfolge deiner Auswahl eingefügt.
- Kopiere die Datei oder lade sie herunter und speichere sie als .gitignore im Stammverzeichnis deines Repositorys. Browser speichern keine Dateien, deren Name mit einem Punkt beginnt. Deshalb wird der Download als gitignore.txt oder gitignore gespeichert: Benenne die Datei in .gitignore um.
Tipps
- Zwei Vorlagen können dasselbe Muster enthalten, etwa node_modules/ in Node und Nextjs. Ein wiederholtes Muster ist unproblematisch.
- Ein Muster hebt die Versionsverwaltung für eine Datei nicht auf, wenn Git sie bereits verfolgt. Um die Verfolgung zu beenden, die Datei aber auf dem Datenträger zu behalten, führe git rm --cached gefolgt vom Pfad der Datei aus und erstelle anschließend einen Commit.
- Eine Zeile, die mit ! beginnt, nimmt Dateien wieder auf, die von einem früheren Muster ausgeschlossen wurden. Die Vorlage für VisualStudioCode verwendet dies, um gemeinsam genutzte Einstellungen wie .vscode/settings.json im Repository zu behalten.
Funktionen
- Offizielle .gitignore-Vorlagen von GitHub, täglich aktualisiert
- Sprachen, Frameworks, Editoren und Betriebssysteme in einer durchsuchbaren Liste
- Schnelloptionen für gängige Projekttypen
- Jede Vorlage mit einer eigenen Überschrift
- Datei kopieren oder herunterladen