Co to jest plik GITIGNORE i jak z niego korzystać?

Podczas pracy z repozytorium git istnieje niebezpieczeństwo niechcianych danych. Na szczęście możesz stworzyć plik z rozszerzeniem GITIGNORE i określić, które pliki i foldery mają być ignorowane w projekcie. Możesz utworzyć globalne dane GITIGNORE do użytku z każdym repozytorium Git.

Co to jest plik GITIGNORE i jak z niego korzystać?

Jak tworzyć pliki GITIGNORE

Pliki GITIGNORE to zwykłe pliki tekstowe, więc możesz je otwierać za pomocą Notatnika lub dowolnego edytora tekstu. Oto jak utworzyć plik GITIGNORE:

  1. Otwórz dowolny edytor tekstu i naciśnij Zapisz. Zmień nazwę na .gitignore.
  2. Podczas edycji pliku każda linia jest zarezerwowana dla pojedynczego folderu lub pliku, który git powinien zignorować.

Użyj „#”, aby dodać komentarze do pliku .gitignore

Użyj „*” dla dopasowania z użyciem symboli wieloznacznych

Użyj #/”, aby zignorować ścieżki względem pliku GITIGNORE.

Na przykład Twój GITIGNORE może wyglądać tak:

# Ignoruj ​​folder node_modules

node_modules

# Ignoruj ​​pliki związane z kluczami API

.env

# Ignoruj ​​pliki systemowe Mac

.DS_store

# Ignoruj ​​pliki konfiguracyjne SASS

.sass-cache

# Ignoruj ​​wszystkie pliki tekstowe

*.tekst

Jak być może wiesz, komentarze są opcjonalne.

Ignoruj ​​katalogi, dołączając ich ścieżki i używając „/” na końcu każdej linii.

Na przykład:

testowanie/

dzienniki/

masa/

Symbolu wieloznacznego „*” można użyć do zignorowania wszystkich plików z określonym rozszerzeniem, ale można go połączyć z symbolem negacji „!”. Oto przykład:

*.tekst

!readme.txt

!główny.txt

Powyższe poinformuje git o ignorowaniu każdego pliku z rozszerzeniem .txt z wyjątkiem readme.txt i main.txt.

Dla katalogów można używać symboli wieloznacznych. Po prostu zachowaj ostrożność podczas ich używania, jak pokazano w tym przykładzie:

test/

!test/przykład.txt

Możesz pomyśleć, że git zignoruje teraz każdy plik w katalogu „test” z wyjątkiem „example.txt”. Tak jednak nie jest. Nadal będzie ignorować plik example.txt ze względu na wydajność, ponieważ zdefiniowaliśmy, że cały katalog „test” jest ignorowany.

Możesz użyć podwójnej gwiazdki (**), aby dopasować dowolną liczbę katalogów i plików. Na przykład Test/**/*.txt powie git, aby ignorował tylko pliki kończące się na .txt w katalogu test i jego podkatalogach.

Plik GITIGNORE Jak korzystać z jednego

Trzy sposoby implementacji plików GITIGNORE

Używaj globalnego GITIGNORE do wszystkich swoich projektów, zarówno z kolegami, jak i sam. Możesz jednak utworzyć lokalny GITIGNORE lub nawet określić reguły wykluczenia.

Utwórz lokalny plik GITIGNORE

Istnieją dwa sposoby definiowania plików GITIGNORE. Możesz mieć plik GITIGNORE na poziomie katalogu lub utworzyć plik w katalogu głównym. W większości przypadków GITIGNORE zawiera plik właściwości i pliki konfiguracyjne. Kiedy twoi koledzy z drużyny również pobierają ten sam plik GITIGNORE, pamiętaj, aby użyć „#”, aby dodać komentarze dla jasności.

Utwórz globalny plik GITIGNORE

Jeśli pracujesz z wieloma repozytoriami git, możesz zaoszczędzić dużo czasu, definiując globalne reguły dla lokalnych repozytoriów.

  1. Utwórz plik GITIGNORE i zdefiniuj uniwersalne reguły do ​​zastosowania.
  2. Użyj właściwości core.excludesFiles, aby przekształcić lokalny plik GITIGNORE na globalny. Użyj następującego wiersza:

git config –global core.excludesFile

Utwórz osobiste zasady GITIGNORE

Jeśli masz określone repozytorium, reguły, możesz modyfikować globalne lub lokalne pliki GITIGNORE. Tych reguł nie można udostępniać ani kontrolować z innymi członkami grupy roboczej. Możesz użyć osobistych reguł GITIGNORE dla lokalnych katalogów roboczych lub ustawień rejestratora.

Używanie pliku GITIGNORE dla zatwierdzonych plików

Ignoruj ​​zatwierdzone pliki

Zatwierdzone pliki integrują się z repozytorium, ponieważ są buforowane. Jeśli zignorujesz te dane, najpierw musisz je usunąć. Sugerowaną metodą wykonania tego jest usunięcie tych plików, a następnie zatwierdzenie i zastosowanie zmian. Gdy to zrobisz, możesz w końcu użyć GITIGNORE, definiując regułę, w której plik będzie ignorowany lokalnie. Dodaj tę linię:

git rm –buforowany

W ten sposób plik zostanie usunięty z repozytorium, nawet jeśli pozostanie w katalogu roboczym. Plik GITIGNORE z tą regułą powinien znajdować się w katalogu roboczym.

Zatwierdź poprzednio ignorowany plik

Jeśli chcesz zatwierdzić plik, który został zignorowany, możesz to zrobić za pomocą linii „git add” i opcji „force”. Na przykład, jeśli chcesz usunąć example.txt z pliku GITIGNORE, zachowując jego zatwierdzone repozytorium, wstaw wiersze:

git add -f przykład.txt

git commit -m „Wymuś dodanie pliku example.txt”.

Właśnie dodałeś zignorowany plik do repozytorium. Ostatnim krokiem jest modyfikacja pliku GITIGNORE poprzez usunięcie wzorca ignorowania lub reguły.

Co to jest plik GITIGNORE Jak z niego korzystać?

Użyj GITIGNORE na swoją korzyść

Ponieważ pliki GITIGNORE są obecne w prawie każdym projekcie, musisz nauczyć się z nich korzystać. Chociaż polecenia są proste, konieczne jest zdefiniowanie reguł i zignorowanie poprawnych plików. Dzięki właściwemu wykorzystaniu GITIGNORE zaoszczędzisz czas i zoptymalizujesz swój projekt.

Jak często potrzebujesz plików GITIGNORE w repozytorium git? Czy najczęściej korzystasz z reguł globalnych czy lokalnych? Podziel się swoimi doświadczeniami w sekcji komentarzy.