Vad är en .gitignore-fil?

En .gitignore-fil talar om för Git vilka filer som ska undantas från versionshanteringen: beroenden som du kan installera igen (som node_modules), byggartefakter, loggar, cachefiler, inställningar för kodredigerare och filer som operativsystemet lämnar kvar, som .DS_Store på macOS eller Thumbs.db på Windows. Lägg den i rotmappen i ditt arkiv. Mönstren gäller för den mappen och alla mappar under den.

Varifrån mallarna kommer

Mallarna kommer från GitHubs officiella samling, arkivet github/gitignore, samma mallar som GitHub erbjuder när du skapar ett arkiv. Verktyget hämtar en kopia som uppdateras varje dag. Mallarna är indelade i tre grupper:

  • Huvudmallar för språk, ramverk och verktyg, som Node, Python, Java, Go, Rust, Unity och WordPress.
  • Globala mallar för kodredigerare, operativsystem och andra verktyg, som macOS, Windows, Linux, VisualStudioCode, JetBrains och Vim. De passar både i ett projekts .gitignore och i den globala .gitignore-filen som Git kan tillämpa på alla dina arkiv.
  • Communitymallar för mer specialiserade ramverk och verktyg, som JavaScript/Vue eller Python/JupyterNotebooks. De underhålls av communityn.

Så här använder du den

  1. Börja med ett snabbval för en populär projekttyp. Det väljer mallar för teknikstacken samt macOS, Windows och den kodredigerare som vanligtvis används med den.
  2. Du kan också söka i fältet Mallar och välja alla språk, ramverk, kodredigerare och operativsystem som projektet använder. Avmarkera en mall eller tryck på Backsteg i fältet för att ta bort den.
  3. .gitignore-filen skapas medan du väljer, med varje mall under en egen kommentarrubrik och i den ordning du valde dem.
  4. Kopiera filen eller ladda ner den och spara den i rotmappen i ditt arkiv som .gitignore. Webbläsare sparar inte filer vars namn börjar med en punkt, så den nedladdade filen får namnet gitignore.txt eller gitignore: byt namn på den till .gitignore.

Tips

  • Två mallar kan innehålla samma mönster, till exempel node_modules/ i Node och Nextjs. Det gör inget om ett mönster förekommer flera gånger.
  • Ett mönster slutar inte spåra en fil som Git redan spårar. Om du vill sluta spåra den men behålla den på disken kör du git rm --cached följt av filens sökväg och gör sedan en commit.
  • En rad som börjar med ! tar tillbaka filer som ett tidigare mönster har ignorerat. Mallen VisualStudioCode använder detta för att behålla delade inställningar, som .vscode/settings.json, i arkivet.

Funktioner

  • GitHubs officiella .gitignore-mallar, uppdateras dagligen
  • Språk, ramverk, kodredigerare och operativsystem i en och samma sökbara lista
  • Snabbval för populära projekttyper
  • Varje mall under sin egen rubrik
  • Kopiera eller ladda ner filen