Что такое файл GITIGNORE и как его использовать?

При работе с git-репозиторием существует опасность попадания нежелательных данных. К счастью, вы можете создать файл с расширением GITIGNORE и определить, какие файлы и папки следует игнорировать в проекте. Вы можете сформировать глобальные данные GITIGNORE для использования с каждым репозиторием Git.

Как создать файлы GITIGNORE

Файлы GITIGNORE представляют собой обычные текстовые файлы, поэтому их можно открыть с помощью Блокнота или любого текстового редактора. Вот как создать файл GITIGNORE:

1. Откройте любой текстовый редактор и нажмите «Сохранить». Измените имя на .gitignore.
2. При редактировании файла каждая строка зарезервирована для одной папки или файла, который git должен игнорировать.

Используйте «#», чтобы добавить комментарии к файлу .gitignore.

Используйте «*» для совпадения с подстановочным знаком.

Используйте #/», чтобы игнорировать пути относительно файла GITIGNORE.

Например, ваш GITIGNORE может выглядеть так:

# Игнорировать папку node_modules

node_modules

# Игнорировать файлы, связанные с ключами API

.env

# Игнорировать системные файлы Mac

.DS_store

# Игнорировать файлы конфигурации SASS

.sass-кэш

# Игнорировать все текстовые файлы

*.текст

Как вы, возможно, знаете, комментарии не обязательны.

Игнорируйте каталоги, включая их пути и используя «/» в конце каждой строки.

Например:

тестирование/

журналы/

нагрузки/

Хотя подстановочный знак «*» можно использовать для игнорирования всех файлов с определенным расширением, его можно комбинировать с символом отрицания «!». Вот пример:

*.текст

!readme.txt

!main.txt

Вышеупомянутое сообщит git игнорировать все файлы с расширением .txt, за исключением readme.txt и main.txt.

Для каталогов можно использовать подстановочные знаки. Просто будьте осторожны при их использовании, как показано в этом примере:

тест/

!test/example.txt

Вы можете подумать, что git теперь будет игнорировать каждый файл в каталоге «test», кроме «example.txt». Однако это не так. Он по-прежнему будет игнорировать файл example.txt из соображений производительности, поскольку мы определили, что игнорируется весь каталог «test».

У вас есть возможность использовать двойную звездочку (**) для сопоставления любого количества каталогов и файлов. Например, Test/**/*.txt сообщит git игнорировать только файлы, заканчивающиеся на .txt, в тестовом каталоге и его подкаталогах.

Три способа реализации файлов GITIGNORE

Используйте глобальный GITIGNORE для всех своих проектов, как с коллегами, так и в одиночку. Однако вы можете создать локальный GITIGNORE или даже указать правила исключения.

Создайте локальный файл GITIGNORE

Существует два способа определения файлов GITIGNORE. Вы можете иметь файл GITIGNORE на уровне каталога или создать файл в корне. В большинстве случаев GITIGNORE включает файл свойств и файлы конфигурации. Когда ваши товарищи по команде также извлекают тот же файл GITIGNORE, обязательно используйте «#», чтобы добавлять комментарии для ясности.

Создайте глобальный файл GITIGNORE

Если вы работаете с несколькими репозиториями git, вы можете сэкономить много времени, определив глобальные правила для ваших локальных репозиториев.

1. Создайте файл GITIGNORE и определите применимые универсальные правила.
2. Используйте свойство core.excludesFiles, чтобы преобразовать локальный файл GITIGNORE в глобальный. Используйте следующую строку:

git config –global core.excludesFile

Создайте персональные правила GITIGNORE

Если у вас есть определенный репозиторий, правила, вы можете изменять глобальные или локальные файлы GITIGNORE. Этими правилами нельзя делиться или управлять ими с другими членами вашей рабочей группы. Вы можете использовать личные правила GITIGNORE для своих локальных рабочих каталогов или настроек регистратора.

Использование файла GITIGNORE для зафиксированных файлов

Игнорировать зафиксированные файлы

Зафиксированные файлы интегрируются в репозиторий, поскольку они кэшируются. Если вы проигнорируете эти данные, их необходимо сначала удалить. Предлагаемый способ сделать это — удалить эти файлы, а затем зафиксировать и применить изменения. Как только вы это сделаете, вы, наконец, сможете использовать GITIGNORE, определив правило, по которому файл будет игнорироваться локально. Добавьте эту строку:

git rm –кешировано

Таким образом, файл будет удален из репозитория, хотя он останется в рабочем каталоге. Файл GITIGNORE с этим правилом должен находиться в рабочем каталоге.

Зафиксировать ранее проигнорированный файл

Если вы хотите зафиксировать файл, который был проигнорирован, вы можете сделать это, используя строку «git add» и опцию «force». Например, если вы хотите удалить файл example.txt из файла GITIGNORE, сохранив его в репозитории, вставьте строки:

git add -f example.txt

git commit -m «Принудительно добавить файл example.txt».

Теперь вы добавили игнорируемый файл в репозиторий. Последний шаг — изменить файл GITIGNORE, удалив шаблон игнорирования или правило.

Используйте GITIGNORE в своих интересах

Поскольку файлы GITIGNORE присутствуют практически в каждом проекте, вам необходимо научиться их использовать. Хотя команды просты, важно определить свои правила и игнорировать правильные файлы. При правильном использовании GITIGNORE вы сэкономите время и оптимизируете свой проект.

Как часто вам нужны файлы GITIGNORE в репозитории git? Вы в основном используете глобальные или локальные правила? Пожалуйста, поделитесь своим опытом в разделе комментариев.