Mikä .gitignore-tiedosto on?

.gitignore-tiedosto kertoo Gitille, mitkä tiedostot jätetään versionhallinnan ulkopuolelle: uudelleen asennettavat riippuvuudet (kuten node_modules), koontitulosteet, lokit, välimuistit, editorin asetukset ja käyttöjärjestelmän jälkeensä jättämät tiedostot, kuten macOS:n .DS_Store tai Windowsin Thumbs.db. Sijoita tiedosto repositoriosi juurikansioon. Sen mallit koskevat kyseistä kansiota ja kaikkia sen alikansioita.

Mistä mallit ovat peräisin

Mallit ovat GitHubin virallisesta mallikokoelmasta eli github/gitignore-repositoriosta. Ne ovat samoja malleja, joita GitHub tarjoaa, kun luot repositorion. Työkalu lataa kokoelmasta kopion, joka päivitetään päivittäin. Mallit on jaettu kolmeen ryhmään:

  • Päämallit kielille, viitekehyksille ja työkaluille, kuten Node, Python, Java, Go, Rust, Unity ja WordPress.
  • Globaalit mallit editoreille, käyttöjärjestelmille ja muille työkaluille, kuten macOS, Windows, Linux, VisualStudioCode, JetBrains ja Vim. Ne sopivat projektin .gitignore-tiedostoon sekä globaaliin tiedostoon, jota Git voi soveltaa kaikkiin repositorioihisi.
  • Yhteisömallit erikoistuneemmille viitekehyksille ja työkaluille. Yhteisö ylläpitää niitä, ja esimerkkejä ovat JavaScript/Vue ja Python/JupyterNotebooks.

Näin käytät työkalua

  1. Aloita suositun projektityypin pikavalinnalla. Se valitsee teknologiapinon mallit sekä macOS:n, Windowsin ja sen kanssa yleensä käytetyn editorin.
  2. Voit myös etsiä Malleja-kentästä ja valita kaikki projektissasi käytettävät kielet, viitekehykset, editorit ja käyttöjärjestelmät. Voit poistaa mallin valinnan tai poistaa sen kentästä painamalla Backspace-näppäintä.
  3. .gitignore-tiedosto muodostuu valintojesi mukaan. Kukin malli lisätään oman otsikkokommenttinsa alle valintajärjestyksessä.
  4. Kopioi tiedosto tai lataa se ja tallenna repositoriosi juurikansioon nimellä .gitignore. Selaimet eivät tallenna tiedostoja, joiden nimi alkaa pisteellä, joten ladatun tiedoston nimi on gitignore.txt tai gitignore. Nimeä se uudelleen muotoon .gitignore.

Vinkkejä

  • Kahdella mallilla voi olla sama malli, kuten node_modules/ Node- ja Nextjs-malleissa. Toistuvasta mallista ei ole haittaa.
  • Malli ei poista tiedoston seurantaa, jos Git seuraa tiedostoa jo ennestään. Voit lopettaa seurannan mutta jättää tiedoston levylle suorittamalla komennon git rm --cached ja lisäämällä sen perään tiedoston polun. Tee sen jälkeen commit.
  • !-merkillä alkava rivi palauttaa tiedostot, jotka aiempi malli jätti huomiotta. VisualStudioCode-malli käyttää tätä ja jättää repositorioon esimerkiksi jaetut asetukset, kuten .vscode/settings.json.

Ominaisuudet

  • GitHubin viralliset .gitignore-mallit, päivitetään päivittäin
  • Kielet, viitekehykset, editorit ja käyttöjärjestelmät yhdessä haettavassa luettelossa
  • Pikavalinnat suosittuihin projektityyppeihin
  • Kukin malli lisätään oman otsikkonsa alle
  • Tiedoston kopiointi tai lataaminen