Czym jest plik .gitignore?

Plik .gitignore informuje Git, które pliki należy pominąć w kontroli wersji: zależności, które można ponownie zainstalować (takie jak node_modules), pliki wynikowe kompilacji, logi, cache, ustawienia edytora oraz pliki pozostawiane przez system operacyjny, takie jak .DS_Store w macOS czy Thumbs.db w Windows. Umieść go w głównym folderze repozytorium. Zawarte w nim wzorce dotyczą tego folderu i wszystkich jego podfolderów.

Skąd pochodzą szablony

Szablony pochodzą z oficjalnej kolekcji GitHub, z repozytorium github/gitignore — są to te same szablony, które GitHub oferuje podczas tworzenia repozytorium. Narzędzie wczytuje ich kopię, która jest odświeżana codziennie. Szablony są podzielone na trzy grupy:

  • Główne szablony dla języków, frameworków i narzędzi, takich jak Node, Python, Java, Go, Rust, Unity i WordPress.
  • Szablony globalne dla edytorów, systemów operacyjnych i innych narzędzi, takich jak macOS, Windows, Linux, VisualStudioCode, JetBrains i Vim. Można ich używać zarówno w pliku .gitignore projektu, jak i w globalnym pliku .gitignore, który Git może stosować do wszystkich repozytoriów.
  • Szablony społeczności dla bardziej wyspecjalizowanych frameworków i narzędzi, utrzymywane przez społeczność, takich jak JavaScript/Vue czy Python/JupyterNotebooks.

Jak używać

  1. Zacznij od szybkiego wyboru dla popularnego typu projektu. Zostaną wybrane szablony używane w danym stosie technologicznym, a także szablony dla macOS, Windows i edytora, z którego zwykle się korzysta.
  2. Możesz też wyszukać szablony w polu Szablony i wybrać wszystkie języki, frameworki, edytory oraz systemy operacyjne używane w projekcie. Aby usunąć szablon, odznacz go lub naciśnij Backspace w polu.
  3. Plik .gitignore jest tworzony na bieżąco podczas wybierania szablonów. Każdy z nich znajduje się pod osobnym komentarzem nagłówkowym, w kolejności, w jakiej zostały wybrane.
  4. Skopiuj plik lub pobierz go i zapisz w głównym folderze repozytorium jako .gitignore. Przeglądarki nie zapisują plików, których nazwa zaczyna się od kropki, dlatego pobrany plik będzie mieć nazwę gitignore.txt lub gitignore. Zmień jego nazwę na .gitignore.

Wskazówki

  • Dwa szablony mogą zawierać ten sam wzorzec, na przykład node_modules/ w szablonach Node i Nextjs. Powtórzony wzorzec nie powoduje żadnych problemów.
  • Wzorzec nie przestaje obejmować pliku, który Git już śledzi. Aby przestać go śledzić, ale pozostawić go na dysku, uruchom git rm --cached, podając ścieżkę do pliku, a następnie wykonaj commit.
  • Wiersz zaczynający się od ! przywraca pliki pominięte przez wcześniejszy wzorzec. Szablon VisualStudioCode używa tego zapisu, aby zachować współdzielone ustawienia, takie jak .vscode/settings.json, w repozytorium.

Funkcje

  • Oficjalne szablony .gitignore od GitHub, odświeżane codziennie
  • Języki, frameworki, edytory i systemy operacyjne na jednej liście z wyszukiwarką
  • Szybki wybór dla popularnych typów projektów
  • Każdy szablon pod osobnym nagłówkiem
  • Kopiowanie lub pobieranie pliku