Co robi to narzędzie
Generator .gitignore tworzy plik .gitignore dla repozytorium, łącząc gotowe szablony. Wybierz języki, frameworki, narzędzia budowania, silniki gier, edytory i systemy operacyjne używane w projekcie, a narzędzie połączy ich reguły w jeden plik z nagłówkiem ### Nazwa ### dla każdej sekcji, gotowy do skopiowania lub pobrania.
Dołączono około sześćdziesięciu szablonów z kolekcji github/gitignore: Node.js, Python, Java, Go, Rust, .NET, Swift, frameworki PHP takie jak Laravel i Symfony, Next.js, Flutter, Android, Terraform, Unity, Unreal Engine, Godot, VS Code, IDE JetBrains, Vim, Emacs, macOS, Windows, Linux i inne. Wszystko działa w przeglądarce; żadne żądania nie są wysyłane.
Jak używać
- Klikaj szablony na liście, aby je dodać. Wyszukiwarka rozpoznaje też popularne aliasy: „typescript” znajdzie Node.js, a „intellij” znajdzie JetBrains.
- Wybrane szablony pojawiają się u góry jako etykiety w kolejności wyboru, a plik zachowuje tę kolejność. Kliknij etykietę, aby ją usunąć, albo Wyczyść, aby zacząć od nowa.
- Wpisy specyficzne dla projektu dodaj w polu Własne reguły, oddzielając przecinkami, np.
.env, /dist, *.local. Trafią na koniec, do sekcji### Custom ###. - Zdecyduj, czy zachować objaśniające komentarze z szablonów i czy usuwać reguły, które zawiera już wcześniejszy szablon.
- Skopiuj wynik lub go pobierz. Pobrany plik nazywa się
.gitignore; zapisz go w katalogu głównym repozytorium.
Wybór jest zapisany w adresie strony, więc zakładka lub udostępniony link odtwarzają ten sam plik.
Przykład
Po wybraniu Node.js, macOS i VS Code, dodaniu własnej reguły .env.local i wyłączeniu komentarzy powstaje plik taki jak ten (skrócony):
### Node.js ###
logs
*.log
npm-debug.log*
…
node_modules/
…
### macOS ###
.DS_Store
.AppleDouble
.LSOverride
…
### VS Code ###
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
!.vscode/*.code-snippets
!*.code-workspace
*.vsix
### Custom ###
.env.local
Wzorce zaczynające się od ! ponownie włączają to, co wykluczyła wcześniejsza reguła: tutaj wspólne ustawienia, zadania i konfiguracje uruchamiania VS Code zostają w repozytorium, a osobisty stan edytora jest ignorowany. Dodanie .env jako własnej reguły niczego by nie zmieniło, bo szablon Node.js już ją zawiera.
Wskazówki
- Reguły dla osobistych narzędzi (pliki wymiany edytora, metadane systemu) umieść w globalnym pliku wykluczeń, aby działały we wszystkich repozytoriach bez powtarzania.
- Ukośnik na końcu, jak w
build/, pasuje tylko do katalogów; ukośnik na początku, jak w/build, wiąże regułę z katalogiem głównym repozytorium. - Polecenie
git check-ignore -v <ścieżka>pokazuje, który wiersz którego pliku ignorowania pasuje do ścieżki. - Nie polegaj na .gitignore przy ochronie sekretów, które już zostały zatwierdzone: wymień je i przepisz historię.
FAQ
› Skąd pochodzą szablony?
To dołączone kopie oficjalnej kolekcji github/gitignore, którą GitHub udostępnia jako domenę publiczną na zasadach CC0. Podczas korzystania z narzędzia nic nie jest pobierane; szablony są częścią strony.
› Dlaczego plik jest nadal śledzony po dodaniu go do .gitignore?
.gitignore działa tylko na nieśledzone pliki. Jeśli plik był już zatwierdzony, usuń go z indeksu poleceniem git rm --cached <plik> (dla folderu z -r) i zrób commit; plik zostanie na dysku i od tej pory będzie ignorowany.
› Co robi opcja Usuń powtórzone reguły?
Wiele szablonów ma wspólne reguły: Java i Kotlin ignorują *.class, C i C++ ignorują *.o. Po włączeniu opcji każda reguła jest zapisywana tylko przy pierwszym wystąpieniu, a komentarz nagłówka, którego wszystkie reguły usunięto, także znika. Wyłącz ją, aby otrzymać każdy szablon dokładnie w opublikowanej postaci.
› Czy plik .gitignore należy commitować?
Tak. Zatwierdzony .gitignore obowiązuje każdego, kto sklonuje repozytorium. Reguły dotyczące tylko twojego komputera, np. edytora czy systemu, możesz też umieścić w globalnym pliku wykluczeń (git config --global core.excludesFile ~/.gitignore_global).