O que é um arquivo GITIGNORE e como devo usá-lo?

Ao trabalhar com um repositório git, existe o perigo de dados indesejados. Felizmente, você pode criar um arquivo com a extensão GITIGNORE e definir quais arquivos e pastas devem ser ignorados no projeto. Você pode formar dados GITIGNORE globais para uso com todos os repositórios Git.

O que é um arquivo GITIGNORE e como faço para usá-lo?

Como criar arquivos GITIGNORE

Os arquivos GITIGNORE são arquivos de texto simples, portanto, você pode abri-los usando o Bloco de notas ou qualquer editor de texto. Aqui está como fazer um arquivo GITIGNORE:

  1. Abra qualquer editor de texto e clique em Salvar. Mude o nome para .gitignore.
  2. Ao editar o arquivo, cada linha é reservada para uma única pasta ou arquivo que um git deve ignorar.

Use “#” para adicionar comentários a um arquivo .gitignore

Use “*” para uma correspondência de curinga

Use # / ”para ignorar os caminhos relativos ao arquivo GITIGNORE.

Por exemplo, seu GITIGNORE pode ser assim:

# Ignore node_modules folder

node_modules

# Ignorar arquivos relacionados a chaves de API

.env

# Ignorar arquivos de sistema do Mac

.DS_store

# Ignorar arquivos de configuração SASS

.sass-cache

# Ignorar todos os arquivos de texto

*.TXT

Como você deve saber, os comentários são opcionais.

Ignore os diretórios incluindo seus caminhos e usando “/” no final de cada linha.

Por exemplo:

testando /

Histórico/

carrega /

Embora o símbolo curinga “*” possa ser usado para ignorar todos os arquivos com uma extensão específica, você pode combiná-lo com o símbolo de negação “!”. Aqui está um exemplo:

*.TXT

! readme.txt

! main.txt

O acima informaria o git para ignorar todos os arquivos com uma extensão .txt, exceto para readme.txt e main.txt.

Curingas podem ser usados ​​para diretórios. Apenas tome cuidado ao usá-los, conforme mostrado neste exemplo:

teste/

! test / example.txt

Você pode pensar que o git irá agora ignorar todos os arquivos dentro do diretório “test“, exceto “example.txt”. No entanto, não é esse o caso. Ele ainda irá ignorar example.txt por motivos de desempenho, já que definimos que todo o diretório "test" será ignorado.

Você tem a opção de usar asterisco duplo (**) para corresponder a qualquer número de diretórios e arquivos. Por exemplo, Test / ** / *. Txt dirá ao git para ignorar apenas os arquivos que terminam com .txt no diretório test e seus subdiretórios.

Arquivo GITIGNORE - Como usar um

Três maneiras de implementar arquivos GITIGNORE

Use um GITIGNORE global com todos os seus projetos, seja com seus colegas ou sozinho. No entanto, você pode criar um GITIGNORE local ou até mesmo especificar regras de exclusão.

Crie um arquivo GITIGNORE local

Existem duas maneiras de definir arquivos GITIGNORE. Você pode ter um arquivo GITIGNORE no nível do diretório ou criar um arquivo na raiz. Na maioria dos casos, GITIGNORE inclui arquivo de propriedades e arquivos de configuração. Quando seus colegas de equipe também estiverem puxando o mesmo arquivo GITIGNORE, certifique-se de usar “#” para adicionar comentários para maior clareza.

Crie um arquivo GITIGNORE global

Se estiver trabalhando com vários repositórios git, você pode economizar muito tempo definindo regras globais para seus repositórios locais.

  1. Crie o arquivo GITIGNORE e defina as regras universais a serem aplicadas.
  2. Use a propriedade core.excludesFiles para transformar seu arquivo GITIGNORE local em global. Use a seguinte linha:

git config –global core.excludesFile

Criar regras pessoais GITIGNORE

Se você tiver um repositório específico, regras, você pode modificar os arquivos GITIGNORE globais ou locais. Essas regras não podem ser compartilhadas ou controladas com outros membros do seu grupo de trabalho. Você pode usar regras pessoais GITIGNORE para seus diretórios de trabalho locais ou configurações de logger.

Usando o arquivo GITIGNORE para arquivos confirmados

Ignorar arquivos confirmados

Os arquivos confirmados são integrados ao repositório, pois são armazenados em cache. Se você ignorar esses dados, eles precisam ser removidos primeiro. O método sugerido para fazer isso é excluir esses arquivos e, em seguida, confirmar e aplicar as alterações. Depois de fazer isso, você pode finalmente usar GITIGNORE definindo uma regra onde o arquivo será ignorado localmente. Adicione esta linha:

git rm –cached

Desta forma, o arquivo será removido do repositório, embora permaneça no diretório de trabalho. Um arquivo GITIGNORE com esta regra deve estar no diretório de trabalho.

Confirmar arquivo anteriormente ignorado

Se você deseja enviar um arquivo que foi ignorado, você pode fazer isso usando a linha “git add” e a opção “force”. Por exemplo, se você deseja remover example.txt do arquivo GITIGNORE enquanto mantém o repositório comprometido, insira as linhas:

git add -f example.txt

git commit -m “Forçar adição de example.txt”.

Agora você adicionou um arquivo ignorado ao repositório. A etapa final é modificar o arquivo GITIGNORE removendo o padrão de ignorar ou a regra.

O que é o arquivo GITIGNORE, como usar um

Use GITIGNORE para sua vantagem

Como os arquivos GITIGNORE estão presentes em quase todos os projetos, você precisará aprender a usá-los. Embora os comandos sejam simples, é essencial definir suas regras e ignorar os arquivos corretos. Com o uso adequado do GITIGNORE, você economizará tempo e otimizará seu projeto.

Com que frequência você precisa de arquivos GITIGNORE no repositório git? Você usa principalmente regras globais ou locais? Por favor, compartilhe suas experiências na seção de comentários.