Настроить игнорирование git ом файлов определенного расширения с использованием glob шаблонов

gitignore — игнорирование файлов в Git

August 28, 2014

В системе Git можно настроить возможность автоматического игнорирования файлов.

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

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

Давайте на практике разберемся, каким образом можно настроить игнорирование файлов в Git с помощью .gitignore .

Создание нового проекта

Создаю новый проект с именем git_ignore , в котором помещаю несколько файлов разного типа:

Инициализирую репозиторий Git в директории .git_ignore , индексирую созданные файлы и фиксирую их:

Вывод команды git status показывает, что все чисто:

Настройка игнорирования в .gitignore

Для настройки игнорирования определенных типов файлов в системе Git необходимо первоначально создать файл .gitignore :

Откроем созданный файл .gitignore в любом редакторе:

… и пропишем в нем следующие строки:

Тем самым мы говорим Git, что нужно игнорировать все файлы с расширением .txt и .md внутри директории git_ignore . То есть, система контроля не будет отслеживать изменения во всех файлах этих типов.

Проиндексируем и зафиксируем изменения (создание файла настроек .gitignore ), а затем проверим данный факт. Для этого в рабочей директории git_ignore создаю еще несколько типов файлов:

Затем выполняю индексацию всех файлов, которые были добавлены или изменены в рабочем каталоге:

И смотрю, что мне показывает команда git status :

Система Git увидела только новый файл main.css . Два других файла — readme.txt и humans.md — проигнорированы системой. Отлично! Зафиксирую изменения.

Можно создать еще пару файлов в разных директориях и посмотреть на вывод команды git status в консоли:

Усложнить задачу игнорирования в .gitignore

Можно усложнить задачу игнорирования в Git, добавив в файл .gitignore директорию, содержимое которой также должно игнорироваться. Пускай это будет обычная директория ignore и скрытая директория .ignore (с точкой перед именем):

Добавлю в файл .gitignore пару строк таким образом:

Проиндексирую изменения, а затем выполню операции по созданию директорий и файлов внутри них:

Вновь ввожу команду просмотра состояния репозитория Git:

Все сработало — Git не захотел видеть директории ignore , .ignore , а также их содержимое. Отлично!

Шаблоны в файле .gitignore

Для файла .gitignore доступны шаблоны, с помощью которых можно задать маски для выборки необходимых типой файлов. Однако, обширная тема шаблонов выходит за рамки данной статьи. При желании можно почитать по теме шаблонов в книге “Pro Git — профессиональный контроль версий”.

TypeScript — размеченные объединения

> Пользовательское объединение типов — что это и как можно использоватьПомимо объединения **примитивных** типов данных (например):<% high. … Continue reading

Источник

Игнорирование файлов и каталогов в Git (.gitignore)

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

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

Какие файлы следует игнорировать?

Игнорируемые файлы обычно представляют собой файлы для конкретной платформы или автоматически созданные файлы из систем сборки. Вот некоторые общие примеры:

• Файлы времени выполнения, такие как файлы журнала, блокировки, кеша или временные файлы.
• Файлы с конфиденциальной информацией, такой как пароли или ключи API.
• Скомпилированный код, например .class или .o .
• /node_modules зависимостей, например /vendor или /node_modules .
• Каталоги сборки, например /public , /out или /dist .
• Системные файлы, такие как .DS_Store или Thumbs.db
• Файлы конфигурации IDE или текстового редактора .

.gitignore Шаблоны

.gitignore — это простой текстовый файл, в каждой строке которого содержится шаблон, который файлы или каталоги следует игнорировать.

Он использует шаблоны подстановки для сопоставления имен файлов с подстановочными знаками. Если у вас есть файлы или каталоги, содержащие шаблон подстановки, вы можете использовать одиночную обратную косую черту ( ) для экранирования символа.

Комментарии

Строки, начинающиеся с решетки ( # ), являются комментариями и игнорируются. Пустые строки можно использовать для улучшения читаемости файла и для группировки связанных строк шаблонов.

Символ косой черты ( / ) представляет собой разделитель каталогов. .gitignore черта в начале шаблона относится к каталогу, в котором находится .gitignore .

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

Если шаблон не начинается с косой черты, он соответствует файлам и каталогам в любом каталоге или подкаталоге.

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

Буквальные имена файлов

Самый простой шаблон — это буквальное имя файла без каких-либо специальных символов.

Шаблон	Примеры совпадений
/access.log	access.log
access.log	access.log logs/access.log var/logs/access.log
build/	build

Подстановочные символы

* — символ звездочки соответствует нулю или более символам.

Шаблон	Примеры совпадений
*.log	error.log logs/debug.log build/logs/error.log

** — Два соседних символа звездочки соответствуют любому файлу или нулю или более каталогам. Если за ним следует косая черта ( / ), он соответствует только каталогам.

Шаблон	Примеры совпадений
logs/**	Соответствует чему-либо в каталоге logs .
**/build	var/build pub/build build
foo/**/bar	foo/bar foo/a/bar foo/a/b/c/bar

? — Знак вопроса соответствует любому одиночному символу.

Шаблон	Примеры совпадений
access?.log	access0.log access1.log accessA.log
foo??	fooab foo23 foo0s

Квадратных скобок

[. ] — соответствует любому из символов, заключенных в квадратные скобки. Когда два символа разделены дефисом — это обозначает диапазон символов. Диапазон включает все символы, которые находятся между этими двумя символами. Диапазоны могут быть буквенными или числовыми.

Если первый символ после [ — восклицательный знак ( ! ), То шаблон соответствует любому символу, кроме символов из указанного набора.

Шаблон	Примеры совпадений
*.[oa]	file.o file.a
*.[!oa]	file.s file.1 file.0
access.2.log	access.0.log access.1.log access.2.log
file.[ac].out	file.a.out file.b.out file.c.out
file.[a-cx-z].out	file.a.out file.b.out file.c.out file.x.out file.y.out file.z.out
access.[!0-2].log	access.3.log access.4.log access.Q.log

Отрицательные паттерны

Шаблон, который начинается с восклицательного знака ( ! ), Отменяет (повторно включает) любой файл, который игнорируется предыдущим шаблоном. Исключением из этого правила является повторное включение файла, если его родительский каталог исключен.

Шаблон	Примеры совпадений
*.log !error.log	error.log или logs/error.log не будут проигнорированы

.gitignore Пример

Ниже приведен пример того, как может выглядеть ваш файл .gitignore :

Местный .gitignore

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

Шаблоны, определенные в файлах, которые находятся в каталогах (подкаталогах) более низкого уровня, имеют приоритет над шаблонами в каталогах более высокого уровня.

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

Личные правила игнорирования

Шаблоны, специфичные для вашего локального репозитория и не подлежащие распространению в другие репозитории, должны быть установлены в файле .git/info/exclude .

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

Глобальный .gitignore

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

Файл можно назвать как угодно и хранить в любом месте. Чаще всего этот файл хранится в домашнем каталоге. Вам придется вручную создать файл и настроить Git для его использования.

Например, чтобы установить

/.gitignore_global в качестве глобального файла игнорирования Git, вы должны сделать следующее:

Добавьте файл в конфигурацию Git:

Откройте файл в текстовом редакторе и добавьте в него свои правила.

Глобальные правила особенно полезны для игнорирования определенных файлов, которые вы никогда не хотите фиксировать, например файлов с конфиденциальной информацией или скомпилированных исполняемых файлов.

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

Файлы в вашей рабочей копии можно отслеживать или нет.

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

Параметр —cached указывает git не удалять файл из рабочего дерева, а только удалять его из индекса.

Чтобы рекурсивно удалить каталог, используйте параметр -r :

Если вы хотите удалить файл и из индекса, и из локальной файловой системы, опустите параметр —cached .

При рекурсивном удалении файлов используйте параметр -n , который выполнит «пробный запуск» и покажет вам, какие файлы будут удалены:

Отладка файла .gitignore

Иногда бывает сложно определить, почему игнорируется конкретный файл, особенно когда вы используете несколько файлов .gitignore или сложные шаблоны. Здесь пригодится команда git check-ignore с параметром -v , которая сообщает git отображать сведения о соответствующем шаблоне.

Например, чтобы проверить, почему файл www/yarn.lock игнорируется, вы должны запустить:

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

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

Отображение всех игнорируемых файлов

Команда git status с параметром —ignored отображает список всех игнорируемых файлов:

Выводы

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

gitignore.io — это онлайн-сервис, который позволяет создавать файлы .gitignore для вашей операционной системы, языка программирования или IDE.

Если у вас есть какие-либо вопросы или отзывы, не стесняйтесь оставлять комментарии.

Источник

Настроить игнорирование git ом файлов определенного расширения с использованием glob шаблонов

Часто при работе над проектом, использующим Git, вы хотите исключить передачу определенных файлов или каталогов в удаленный репозиторий.

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

Какие файлы следует игнорировать?

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

• Runtime файлы, такие как log , lock , cache или временные файлы ( tmp ).
• Файлы с конфиденциальной информацией, такие как пароли или ключи API.
• Каталоги зависимостей, такие как /vendor или /node_modules .
• Build каталоги, такие как /public или /dist .
• Системные файлы, такие как .DS_Store или Thumbs.db
• Конфигурационные файлы IDE или текстового редактора.

Шаблоны .gitignore

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

.gitignore использует glob шаблоны для сопоставления имен файлов с символами подстановки (Это что-то вроде регулярных выражений). Если у вас есть файлы или каталоги, содержащие шаблон подстановки (например * ), вы можете использовать один обратный слеш ( \* ), чтобы экранировать такой символ.

Комментарии

Строки, начинающиеся со знака хэша (# ), являются комментариями и игнорируются. Пустые строки могут быть использованы для улучшения читабельности файла и группировки связанных строк шаблонов.

Символ косой черты ( / ) представляет собой разделитель каталогов. Наклонная черта в начале шаблона относится к директории, в которой находится файл .gitignore .
Если шаблон начинается со слеша, то он соответствует файлам и каталогам только в корне хранилища.

Если шаблон не начинается со слэша, он соответствует файлам и каталогам в любом каталоге или подкаталоге.

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

Имена файлов

Самый простой шаблон — это просто имя файла без каких-либо специальных символов.

Шаблон	Примеры совпадений
/access.log	access.log
access.log	access.log logs/access.log var/logs/access.log
build/	build

Символы подстановки

* — Символ звездочки соответствует нулю или более символам.

ШАБЛОН	ПРИМЕРЫ СОВПАДЕНИЙ
*.log	error.log logs/debug.log build/logs/error.log

** — Два соседних символа звездочки соответствуют любому файлу или нулю или более каталогам. Когда за ним следует косая черта ( / ), она соответствует только каталогам.

ШАБЛОН	ПРИМЕРЫ СОВПАДЕНИЙ
logs/**	Совпадает со всем, что находится в каталоге logs.
**/build	var/build pub/build build
foo/**/bar	foo/bar foo/a/bar foo/a/b/c/bar

? — Вопросительный знак соответствует любому отдельному символу.

ШАБЛОН	ПРИМЕРЫ СОВПАДЕНИЙ
access?.log	access0.log access1.log accessA.log
foo??	fooab foo23 foo0s

Квадратные скобки

[…] — Совпадает с любыми символами, заключенными в квадратные скобки. Когда два символа разделены дефисом — обозначает диапазон символов. Диапазон включает в себя все символы, находящиеся между этими двумя символами. Диапазон может быть алфавитным или цифровым.

Если первый символ после [ является восклицательным знаком ( ! ), то образец соответствует любому символу, кроме символов из указанного набора.

ШАБЛОН	ПРИМЕРЫ СОВПАДЕНИЙ
*.[oa]	file.o file.a
*.[!oa]	file.s file.1 file.0
access.1.log	access.0.log access.1.log access.2.log
file.[a-c].out	file.a.out file.b.out file.c.out
file.[a-cx-z].out	file.a.out file.b.out file.c.out file.x.out file.y.out file.z.out
access.[!0-2].log	access.3.log access.4.log access.Q.log

Исключающие шаблоны

Шаблон, начинающийся с восклицательного знака ( ! ), отменяет (повторно включает) любой файл, игнорируемый предыдущей шаблоном. Исключением из этого правила является повторное включение файла, если его родительский каталог исключен.

ШАБЛОН	ПРИМЕРЫ СОВПАДЕНИЙ
*.log !error.log	error.log or logs/error.log will not be ignored

Пример .gitignore

Ниже приведен пример того, как может выглядеть ваш файл .gitignore:

Локальный .gitignore

Локальный файл .gitignore обычно помещается в корневую директорию хранилища. Однако вы можете создать несколько файлов .gitignore в различных подкаталогах в вашем репозитории. Шаблоны в файлах .gitignore сопоставляются относительно директории, в которой находится файл.
Шаблоны, определенные в файлах, которые находятся в каталогах нижнего уровня (подкаталогах), имеют приоритет перед файлами в каталогах верхнего уровня.

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

Персональные правила игнорирования

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

Глобальный .gitignore

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

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

Например, чтобы установить

/.gitignore_global в качестве глобального файла игнорирования Git, выполните следующие действия:

1. Создайте файл:

2. Добавьте этот файл в Git-конфигурацию:

3. Откройте файл в текстовом редакторе и добавьте в него свои правила.

Глобальные правила особенно полезны при игнорировании определенных файлов, которые вы никогда не захотите фиксировать, таких как файлы с конфиденциальной информацией или скомпилированные исполняемые файлы.

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

Файлы в вашей рабочей копии могут отслеживаться или не отслеживаться.

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

Опция —cached говорит не удалять файл из рабочего дерева, а только удалять его из индекса.

Для рекурсивного удаления каталога используйте параметр -r :

Если вы хотите удалить файл как из индексной, так и из локальной файловой системы, опустите опцию —cached .

При рекурсивном удалении файлов используйте опцию -n , которая выполнит пробный запуск и покажет, какие файлы будут удалены:

Отладка файла .gitignore

Иногда бывает сложно определить, почему тот или иной файл игнорируется, особенно если вы используете несколько файлов .gitignore или сложные шаблоны. В этом случае пригодится команда git check-ignore с опцией -v, которая указывает на то, что нужно отображать детали совпадающего шаблона.

Например, чтобы проверить, почему файл www/yarn.lock игнорируется, нужно выполнить следующее:

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

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

Отображение всех игнорируемых файлов

Команда git status с опцией -ignored отображает список всех проигнорированных файлов:

Заключение

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

Источник