Настройка файлов исключений .gitignore что туда записывать

Как настроить файлы исключений .gitignore что туда записывать

Файл .gitignore — это конфигурационный файл в корне Git-репозитория, который содержит список файлов и директорий, которые Git должен игнорировать и не отслеживать при коммитах. В этот файл записывают пути к временным файлам, логам, зависимостям, переменным окружения и другим артефактам, которые не должны быть в системе контроля версий.

Зачем это нужно

  • Файл .gitignore предотвращает случайный коммит конфиденциальной информации, таких как пароли, API ключи и токены доступа
  • Игнорирование зависимостей (папка node_modules, vendor) уменьшает размер репозитория и ускоряет клонирование проекта
  • Исключение локальных конфигурационных файлов (.env, config.local.php) позволяет разработчикам использовать персональные настройки без конфликтов
  • Игнорирование временных файлов операционной системы (.DS_Store, Thumbs.db) снижает шум в истории коммитов
  • Исключение файлов кэша, логов и артефактов сборки (dist, build, .log) предотвращает загрязнение репозитория
  • Использование .gitignore обеспечивает чистоту рабочего директория и упрощает код-ревью
  • Игнорирование IDE-специфичных файлов (.vscode, .idea) позволяет разработчикам использовать разные редакторы
  • Правильно настроенный .gitignore предотвращает случайное внесение незавершённых или отладочных файлов в основную ветку

Пошаговая инструкция

  1. Откройте командную строку или терминал в корневой директории вашего Git-репозитория
  2. Создайте файл .gitignore командой touch .gitignore (на Linux/Mac) или type nul > .gitignore (на Windows)
  3. Откройте файл .gitignore в текстовом редакторе (Visual Studio Code, Sublime Text, Notepad++)
  4. Добавьте строку node_modules/ для исключения папки с npm-зависимостями
  5. Добавьте строку .env для игнорирования файла с переменными окружения и секретными данными
  6. Добавьте строку .env.local для исключения локальной конфигурации переменных окружения
  7. Добавьте строку dist/ или build/ для игнорирования директории с собранным кодом
  8. Добавьте строку .DS_Store для исключения системных файлов macOS
  9. Добавьте строку Thumbs.db для исключения кэша миниатюр Windows
  10. Добавьте строку *.log для игнорирования всех файлов логов с расширением .log
  11. Добавьте строку .vscode/ для исключения конфигурации VS Code
  12. Добавьте строку .idea/ для исключения конфигурации JetBrains IDE (WebStorm, PhpStorm, IntelliJ)
  13. Добавьте строку vendor/ для исключения PHP-зависимостей (Composer)
  14. Добавьте строку *.swp и *.swo для исключения временных файлов Vim
  15. Добавьте строку .DS_Store и .AppleDouble для полного исключения macOS файлов
  16. Добавьте строку npm-debug.log для исключения npm логов
  17. Добавьте строку yarn-error.log для исключения ошибок Yarn
  18. Добавьте строку .cache/ для исключения папки кэша приложений
  19. Добавьте строку *.pyc для исключения скомпилированных Python файлов
  20. Добавьте строку __pycache__/ для исключения кэша Python
  21. Используйте подстановочный символ * для согласованного совпадения имён (например, *.tmp игнорирует все временные файлы)
  22. Используйте символ ! для исключения файла из игнорирования (например, !.env.example если нужен шаблон)
  23. Используйте слеш / в конце пути, чтобы указать директорию (например, logs/ игнорирует только папку, не файлы)
  24. Сохраните файл .gitignore в текстовом редакторе
  25. Выполните команду git add .gitignore для добавления файла в индекс
  26. Выполните команду git commit -m "Add .gitignore configuration" для коммита файла
  27. Выполните команду git push для отправки файла на удалённый репозиторий
  28. Проверьте работу .gitignore командой git status — в списке не должны отображаться игнорируемые файлы
  29. Для повторного применения .gitignore к уже отслеживаемым файлам выполните git rm --cached -r . и затем git add .

Часто задаваемые вопросы

Что делать, если файл был добавлен до создания .gitignore? Удалите файл из отслеживания командой git rm --cached имя-файла, затем добавьте его в .gitignore и сделайте новый коммит.

Как проверить, действительно ли Git игнорирует нужные файлы? Используйте команду git check-ignore -v имя-файла для проверки, применяется ли правило .gitignore к конкретному файлу.

Можно ли использовать разные .gitignore файлы для разных директорий? Да, можно создать .gitignore в любой поддиректории проекта, и правила будут применяться только к этой папке и её содержимому.

Похожие материалы

Посмотреть историю коммитов в Git через команду git log
Сохранить изменения без коммита команда git stash
Полезные расширения для VS Code упрощающих написание кода