Как использовать файлы .gitignore

Первое на что обещают внимание опытные сотрудники это на ошибку, которую совершают студенты и выпускники, начиная свои побочные проекты, заключается в том, что они забывают добавить файл .gitignore. В этой статье мы обсудим, что такое файл .gitignore, как вы настраиваете файл .gitignore и почему это важно.

Файл .gitignore

Проще говоря, файл .gitignore - это текстовый файл, который сообщает git не отслеживать определенные файлы, каталоги или типы файлов.

Например, следующий файл .gitignore сообщает git игнорировать файлы .suo, .dll и все, что находится в каталоге node_modules:

Полные файлы .gitignore намного больше этого, но это дает вам хорошее представление о том, что находится в типичном файле .gitignore.

Если в вашем репозитории есть файл .gitignore, git проигнорирует все соответствующие файлы и папки, когда вы попытаетесь их добавить.

Не каждый файл в ваших программных проектах критически важен и должен отслеживаться git. Многие файлы являются специфическими результатами компиляции вашего кода на одном конкретном компьютере или операционной системе и не должны отслеживаться системой контроля версий. Например, два пользователя в двух разных операционных системах могут сгенерировать два разных исполняемых файла из одного и того же кода. В то время как исполняемый файл может работать на одном компьютере, это может вызвать серьезные проблемы для другого.

Кроме того, многие временные файлы занимают значительный объем дискового пространства и могут сделать ваш репозиторий git неоправданно большим.

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

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

Создание файла .gitignore

Теперь, когда мы обсудили, что такое файл .gitignore и зачем он вам нужен, давайте поговорим о том, как вы его получаете.

Обычно вы получаете файл .gitignore одним из двух способов:

• Вы сами создаете файл .gitignore и вручную добавляете в него правила
• Вы начинаете с предварительно созданного файла .gitignore, который соответствует языкам и технологиям, с которыми вы работаете.
  

Создать файл .gitignore так же просто, как щелкнуть правой кнопкой мыши в проводнике и выбрать создание нового файла, а затем назвать его .gitignore. Вы также можете запустить команду touch bash, чтобы создать пустой файл с помощью touch .gitignore.

Однако мы почти никогда вручную не создали файл .gitignore. Вместо этого мы начинаем с уже существующего шаблона.

Использование существующего шаблона .gitignore

Большую часть времени мы начинаем свои проекты с использования уже существующего шаблона .gitignore.

Один из вариантов, который GitHub и другие поставщики git предоставляют вам при создании нового репозитория, заключается в выборе шаблона .gitignore из списка поддерживаемых, как показано ниже:

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

Эта функция значительно помогает при создании новых репозиториев, но что, если вы уже создали свой репозиторий?

К счастью, GitHub публикует репозиторий GitIgnore, который содержит множество файлов .gitignore для различных языков. Это наш ресурс по умолчанию, когда нам нужен найти новый файл .gitignore и у нас нет шаблона, который можно было бы позаимствовать из существующего проекта.

Добавление в файл .gitignore

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

Если вы найдете определенные файлы или папки, которые хотите добавить в файлы .gitignore, просто добавьте файлы по их имени или пути в нижнюю часть файла .gitignore.

Например, чтобы игнорировать файл workspace.json в каталоге .obsidian и содержимое подкаталога _gen в каталоге resources, вам следует добавить следующие записи:

Смотрите документацию git для получения дополнительной информации о шаблонах и форматировании, поддерживаемых в файлах .gitignore.

Кроме того, многие графические инструменты git, такие как GitKraken, позволят вам щелкнуть правой кнопкой мыши на файлах и добавить их в ваш файл .gitignore во время фиксации.

Заключительные мысли

В целом, файлы .gitignore - это гибкий и простой способ контролировать то, что попадает в ваши репозитории git.

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

Мораль этой истории: если вы работаете с git, заведите файл .gitignore, и ваш код будет более переносимым, содержать меньше “ненужных” файлов, занимать меньше места и будет больше походить на профессиональный код.