Git hooks — это скрипты, которые Git запускает автоматически в различных точках своего жизненного цикла. Их можно использовать для автоматизации задач, таких как выполнение тестов, линтинга кода или выполнения других действий при определенных событиях, например, перед коммитом или после получения обновлений. Это мощный инструмент для повышения качества кода и улучшения рабочего процесса.

Основные типы Git hooks

Git hooks делятся на два вида: клиентские и серверные.

Клиентские хуки: запускаются на стороне клиента и могут быть использованы для обработки действий, таких как коммиты или слияния.

pre-commit: запускается перед тем, как коммит будет создан. Может использоваться для проверки кода на соответствие стандартам.
commit-msg: запускается после ввода сообщения коммита. Можно использовать для проверки или форматирования сообщения.

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

pre-receive: запускается перед приемом данных в репозиторий. Может использоваться для проверки входящих изменений.
post-receive: запускается после успешного обновления репозитория. Можно использовать для уведомления о развертывании.

Как настроить Git hooks

Git hooks хранятся в каталоге .git/hooks вашего репозитория и представляют собой обычные скрипты. Чтобы настроить хуки, вам нужно сделать следующие шаги:

Перейдите в каталог хуков:

cd путь/к/вашему/репозиторию/.git/hooks

Создайте или отредактируйте скрипт: Например, создадим хук pre-commit, который проверяет, есть ли ошибки формата в JavaScript-файлах с помощью ESLint:

touch pre-commit
chmod +x pre-commit  # Сделаем скрипт исполняемым

Откройте файл pre-commit и добавьте следующий код:

#!/bin/sh

# Проверяем форматирование кода с помощью ESLint
eslint . --ext .js,.jsx,.ts,.tsx

if [ $? -ne 0 ]; then
    echo "Ошибка форматирования! Исправьте ошибки и попробуйте снова."
    exit 1
fi

Этот скрипт запустит команду eslint и, если будут найдены ошибки форматирования, отобразит сообщение и завершит процесс коммита.

Проверьте работу хука: Попробуйте сделать коммит с ошибками форматирования. Если все работает правильно, коммит не будет выполнен, пока вы не исправите все ошибки.

Дополнительные советы

Типы хуков: Вы можете создавать хуки для различных событий, добавляя соответствующие исполняемые файлы в каталог .git/hooks.
Управление конфигурацией: Если ваш проект основывается на Git, вам стоит рассмотреть возможность управления хуками через систему управления версиями, например, сделать копии хуков в вашем репозитории и устанавливать их в .git/hooks при инициализации проекта с помощью скрипта install в package.json.
Использование библиотек: Существуют автоматизированные инструменты, такие как Husky, которые упрощают настройку и управление хуками для проектов на JavaScript и TypeScript. Это может существенно упростить задачу, особенно для новичков.

Использование Git hooks может значительно улучшить рабочий процесс, автоматизируя задачи и обеспечивая более высокое качество кода до момента его попадания в репозиторий.

Предыдущий вопрос

Что такое git hook и как его можно использовать?

Следующий вопрос

Какова роль файла `.git/index`?

Содержание:

Основные типы Git hooks

Как настроить Git hooks

Дополнительные советы

Редактировать