Čo je súbor GITIGNORE a ako ho môžem použiť?

Pri práci s úložiskom git existuje nebezpečenstvo nechcených údajov. Našťastie môžete vytvoriť súbor s príponou GITIGNORE a definovať, ktoré súbory a priečinky sa majú v projekte ignorovať. Môžete vytvoriť globálne údaje GITIGNORE na použitie s každým úložiskom Git.

Čo je súbor GITIGNORE a ako ho môžem použiť?

Ako vytvoriť súbory GITIGNORE

Súbory GITIGNORE sú obyčajné textové súbory, takže ich môžete otvoriť pomocou programu Poznámkový blok alebo ľubovoľného textového editora. Tu je návod, ako vytvoriť súbor GITIGNORE:

  1. Otvorte ľubovoľný textový editor a kliknite na tlačidlo Uložiť. Zmeňte názov na .gitignore.
  2. Pri úprave súboru je každý riadok vyhradený pre jeden priečinok alebo súbor, ktorý by mal git ignorovať.

Ak chcete pridať komentáre k súboru .gitignore, použite znak „#“.

Pre zhodu so zástupným znakom použite „*“.

Použite #/” na ignorovanie ciest relatívne k súboru GITIGNORE.

Ako príklad môže váš GITIGNORE vyzerať takto:

# Ignorovať priečinok node_modules

node_modules

# Ignorujte súbory súvisiace s kľúčmi API

.env

# Ignorovať systémové súbory Mac

.DS_store

# Ignorujte konfiguračné súbory SASS

.sass-cache

# Ignorovať všetky textové súbory

*.TXT

Ako možno viete, komentáre sú voliteľné.

Ignorujte adresáre zahrnutím ich ciest a použitím „/“ na konci každého riadku.

Napríklad:

testovanie/

denníky/

zaťaženie/

Zatiaľ čo zástupný znak „*“ možno použiť na ignorovanie všetkých súborov s konkrétnou príponou, môžete ho skombinovať so symbolom negácie „!“. Tu je príklad:

*.TXT

!readme.txt

!main.txt

Vyššie uvedené by informovalo git, aby ignoroval každý súbor s príponou .txt okrem readme.txt a main.txt.

Pre adresáre možno použiť zástupné znaky. Pri ich používaní buďte opatrní, ako ukazuje tento príklad:

test/

!test/example.txt

Možno si myslíte, že git bude teraz ignorovať každý súbor v adresári „test“ okrem „example.txt“. Nie je to však tak. Stále bude ignorovať example.txt z dôvodov výkonu, pretože sme definovali, že celý „test“ adresár je ignorovaný.

Máte možnosť použiť dvojitú hviezdičku (**) na priradenie ľubovoľného počtu adresárov a súborov. Napríklad Test/**/*.txt povie git, aby ignoroval iba súbory končiace na .txt v testovacom adresári a jeho podadresároch.

Súbor GITIGNORE Ako používať jeden

Tri spôsoby, ako implementovať súbory GITIGNORE

Používajte globálne GITIGNORE so všetkými svojimi projektmi, či už s kolegami alebo sami. Môžete však vytvoriť miestne GITIGNORE alebo dokonca zadať pravidlá vylúčenia.

Vytvorte lokálny súbor GITIGNORE

Existujú dva spôsoby, ako definovať súbory GITIGNORE. Môžete mať súbor GITIGNORE na úrovni adresára alebo vytvoriť súbor v koreňovom adresári. Vo väčšine prípadov GITIGNORE obsahuje súbor vlastností a konfiguračné súbory. Keď vaši spoluhráči tiež sťahujú rovnaký súbor GITIGNORE, nezabudnite použiť „#“ na pridanie komentárov pre prehľadnosť.

Vytvorte globálny súbor GITIGNORE

Ak pracujete s viacerými úložiskami git, môžete ušetriť veľa času definovaním globálnych pravidiel pre vaše lokálne úložiská.

  1. Vytvorte súbor GITIGNORE a definujte univerzálne pravidlá, ktoré sa majú použiť.
  2. Použite vlastnosť core.excludesFiles na transformáciu vášho lokálneho súboru GITIGNORE na globálny. Použite nasledujúci riadok:

git config –global core.excludesFile

Vytvorte si osobné pravidlá GITIGNORE

Ak máte špecifické úložisko, pravidlá, môžete upraviť globálne alebo lokálne súbory GITIGNORE. Tieto pravidlá nie je možné zdieľať ani ovládať s ostatnými členmi vašej pracovnej skupiny. Môžete použiť osobné pravidlá GITIGNORE pre vaše lokálne pracovné adresáre alebo nastavenia zapisovača.

Použitie súboru GITIGNORE pre splnené súbory

Ignorovať potvrdené súbory

Odovzdané súbory sa integrujú do úložiska, pretože sú uložené vo vyrovnávacej pamäti. Ak tieto údaje ignorujete, musíte ich najskôr odstrániť. Navrhovaný spôsob, ako to urobiť, je odstrániť tieto súbory a potom potvrdiť a použiť zmeny. Keď to urobíte, môžete konečne použiť GITIGNORE definovaním pravidla, podľa ktorého bude súbor lokálne ignorovaný. Pridajte tento riadok:

git rm – uložený vo vyrovnávacej pamäti

Týmto spôsobom bude súbor odstránený z úložiska, aj keď zostane v pracovnom adresári. Súbor GITIGNORE s týmto pravidlom by mal byť v pracovnom adresári.

Potvrdiť predtým ignorovaný súbor

Ak chcete odovzdať súbor, ktorý bol ignorovaný, môžete to urobiť pomocou riadku „git add“ a možnosti „force“. Napríklad, ak chcete odstrániť example.txt zo súboru GITIGNORE a zároveň ho ponechať v repozitári, vložte riadky:

git add -f example.txt

git commit -m “Vynútiť pridanie example.txt”.

Teraz ste do úložiska pridali ignorovaný súbor. Posledným krokom je úprava súboru GITIGNORE odstránením ignorujúceho vzoru alebo pravidla.

Čo je súbor GITIGNORE Ako ho používať

Využite GITIGNORE vo svoj prospech

Keďže súbory GITIGNORE sú prítomné takmer v každom projekte, budete sa musieť naučiť, ako ich používať. Aj keď sú príkazy jednoduché, je dôležité definovať pravidlá a ignorovať správne súbory. Pri správnom používaní GITIGNORE ušetríte čas a optimalizujete svoj projekt.

Ako často potrebujete súbory GITIGNORE v úložisku git? Používate väčšinou globálne alebo lokálne pravidlá? Podeľte sa o svoje skúsenosti v sekcii komentárov.