Debugowanie pliku .gitignore

Opublikowane przez Tomasz Prasołek w dniu 7 lipca 20197 lipca 2019

Dzisiaj będzie krótki wpis o pliku .gitignore. Jeśli miałeś kiedyś problem z ignorowanymi plikami np. nie wiedziałeś akurat czemu dany plik (lub pliki) są ignorowane to ten post jest dla Ciebie. Pokażę prostą sztuczkę jak sprawdzić dlaczego konkretny plik jest ignorowany.

Przygotowanie repozytorium

Mamy taką sytuację:

Repozytorium, w którym mamy jeden plik i 2 foldery. Będziemy ignorować wszystkie pliki z rozszerzeniem txt w katalogu AnotherFolder.

Mamy taką zapomnianą regułę w .gitignore:

SomeFolderWithFiles/AnotherFolder/*.txt

Do folderu AnotherFolder dodajemy plik documentation.txt:

Ale okazuje się, że Git nie widzi tego pliku:

$ git status
On branch master
nothing to commit, working tree clean

Jak sprawdzić dlaczego ten plik jest ignorowany?

check-ignore

Wpisujemy polecenie:

git check-ignore -v SomeFolderWithFiles/AnotherFolder/documentation.txt

I dostajemy informację:

.gitignore:11:SomeFolderWithFiles/AnotherFolder/*.txt   SomeFolderWithFiles/AnotherFolder/documentation.txt

W pliku .gitignore w 11 linii jest reguła SomeFolderWithFiles/AnotherFolder/*.txt przez którą plik jest ignorowany.

Ważne w poleceniu jest opcja -v, dzięki temu pokazuje Nam więcej informacji. Bez tego – jeśli plik jest ignorowany – to wyświetli tylko jego ścieżkę 🙂

Podsumowanie

To sprawdzenie na pewno się przyda jeśli mamy kilka własnych reguł wprowadzonych do ignorowania różnych katalogów lub plików z konkretnym rozszerzeniem. Po pewnym czasie zapomina się o takich ustawieniach. Wtedy check-ignore się przyda.

Źródła:
https://git-scm.com/docs/git-check-ignore