husky – один из наиболее популярных инструментов для управления хуками Git. Если вы хотите автоматически выполнять определенные действия перед или после коммитов, этот инструмент может быть идеальным решением.
Настройка husky очень проста. Сначала вам нужно установить его в вашем проекте. Для этого вы можете использовать пакетный менеджер npm или yarn. Просто запустите команду:
npm install husky --save-dev
или
yarn add husky --dev
После установки husky нужно добавить необходимые команды в секцию scripts вашего файла package.json. Например, можно добавить команды, которые проверят ваш код перед коммитом или запустят тесты.
Теперь, когда вам нужно настроить husky для конкретных хуков Git, создайте соответствующий скрипт в секции scripts. Затем используйте команды husky, такие как pre-commit или pre-push, и привяжите их к вашим скриптам.
Установка husky
Шаг 1: Откройте командную строку в вашем проекте.
Шаг 2: Введите следующую команду для установки husky:
npm install husky —save-dev
Шаг 3: После завершения установки, вы должны добавить скрипт в ваш package.json файл:
«husky»: { «hooks»: { «pre-commit»: «eslint .», «pre-push»: «npm test» } }
Предполагается, что вы уже установили eslint и настроили его для вашего проекта. Это позволит husky запускать eslint перед коммитом.
Создание конфигурационного файла
Перед настройкой husky в проекте необходимо создать конфигурационный файл, в котором определены правила и команды, выполняемые при git-хуках.
Шаг 1: В корневой директории проекта создайте файл «.huskyrc» или «.huskyrc.json».
Шаг 2: Откройте созданный файл и определите нужные git-хуки.
Пример конфигурационного файла «.huskyrc»:
{
"hooks": {
"pre-commit": "npm run lint",
"pre-push": "npm run test"
}
}
В данном примере заданы два git-хука: «pre-commit» и «pre-push».
pre-commit: Этот хук выполнится перед отправкой коммита. В нашем примере при запуске хука будет выполняться команда «npm run lint», которая проверяет код на соответствие стилю оформления.
pre-push: Этот хук выполнится перед отправкой изменений на сервер. В нашем примере при запуске хука будет выполняться команда «npm run test», которая запускает тесты проекта.
Шаг 3: Сохраните файл.
После создания конфигурационного файла и определения git-хуков, можно приступать к настройке husky и использованию его функционала в проекте.
Настройка pre-commit хука
Хук pre-commit позволяет запускать определенный набор команд перед каждым коммитом в проекте. Это может быть очень полезно для автоматической проверки кода перед его отправкой, чтобы убедиться, что коммит не нарушит соглашения стиля, не содержит ошибок или не сбился с актуальной версией зависимостей.
Для настройки pre-commit хука в проекте, необходимо выполнить следующие шаги:
- Убедитесь, что у вас установлен husky, команда для установки:
npm install husky --save-dev. - Создайте файл .husky/pre-commit в корневом каталоге вашего проекта.
- Откройте созданный файл и добавьте нужные команды, которые должны выполняться перед каждым коммитом. Например, можно добавить команды для запуска линтера, проверки типов, тестирования и т.д. Пример файла .husky/pre-commit:
#!/bin/sh
echo "Running pre-commit hooks"
npm run lint
if [ $? -ne 0 ]; then
echo "Linting failed. Aborting commit."
exit 1
fi
npm run test
if [ $? -ne 0 ]; then
echo "Tests failed. Aborting commit."
exit 1
fi
echo "Pre-commit hooks passed"
exit 0
В приведенном примере выполняются команды для запуска линтера и тестирования перед каждым коммитом.
Сохраните файл .husky/pre-commit после добавления нужных команд.
Теперь, когда вы будете делать коммит в проекте, хук pre-commit будет автоматически запускаться, и коммит будет прерываться, если какая-либо из заданных команд вернет ошибку.
Таким образом, настройка pre-commit хука позволяет автоматизировать проверку кода перед коммитом и обеспечивает более высокую качества вашего проекта.
Добавление коммит-линтера
Чтобы осуществить полный контроль над сообщениями коммитов и сохранить некоторые стандарты при их написании, вам необходимо добавить коммит-линтер в свой проект. В качестве коммит-линтера мы будем использовать commitlint.
Для начала, установите commitlint в свой проект с помощью менеджера пакетов npm:
npm install --save-dev @commitlint/{config-conventional,cli}Затем создайте файл commitlint.config.js в корне вашего проекта и добавьте в него следующий код:
module.exports = { extends: ['@commitlint/config-conventional'] }После этого вам необходимо добавить правило в файл .huskyrc для запуска коммит-линтера перед каждым коммитом:
"hooks": {
"pre-commit": "npm run lint:commit"
}Теперь вам нужно добавить соответствующий скрипт в раздел scripts вашего файла package.json:
"scripts": {
"lint:commit": "commitlint -e $GIT_PARAMS"
}Теперь при каждом коммите будет запускаться коммит-линтер, который проверит соответствие сообщения коммита стандартам, определенным в файле commitlint.config.js. Если сообщение коммита не соответствует стандартам, коммит будет отклонен.
Таким образом, вы можете гарантировать, что все сообщения коммитов в вашем проекте имеют единый формат и соответствуют определенным требованиям. Это значительно упрощает чтение и анализ истории коммитов, а также повышает понятность вашего проекта для других разработчиков.
Настройка pre-push хука
Хук pre-push выполняется перед отправкой изменений в удаленный репозиторий. С помощью pre-push можно добавить дополнительные проверки и скрипты, которые будут запускаться автоматически перед каждым push-событием.
Для настройки pre-push хука в проекте с использованием husky необходимо выполнить несколько простых шагов:
- Установите пакет husky в вашем проекте с помощью npm или yarn:
«`shell
npm install husky —save-dev
«`shell
yarn add husky —dev
- Добавьте команду pre-push в секцию «scripts» вашего файла package.json:
«`json
{
«scripts»: {
«pre-push»: «npm run lint»
}
}
В данном случае, перед каждым push-событием будет выполнена команда «npm run lint». Вы можете заменить эту команду на любую другую, которая выполнит необходимые проверки и скрипты перед отправкой изменений.
Если вы используете yarn, то команда будет выглядеть следующим образом:
«`json
{
«scripts»: {
«pre-push»: «yarn lint»
}
}
- Добавьте следующий код в секцию «husky» вашего файла package.json:
«`json
{
«husky»: {
«hooks»: {
«pre-push»: «npm run pre-push»
}
}
}
Теперь husky будет использовать команду «npm run pre-push» перед выполнением push-события.
Если вы используете yarn, то необходимо заменить «npm» на «yarn» в данном коде:
«`json
{
«husky»: {
«hooks»: {
«pre-push»: «yarn run pre-push»
}
}
}
Теперь хук pre-push настроен и будет выполняться перед каждым push-событием в вашем проекте.
Обратите внимание, что husky поддерживает не только выполнение команд, но и запуск скриптов из вашего проекта. Таким образом, вы можете создать специальный скрипт, который будет содержать все необходимые проверки и действия перед отправкой изменений в удаленный репозиторий.
Использование git hooks
Один из самых распространенных способов использования git hooks — это запуск автоматической проверки кода перед коммитом. Такой подход позволяет предотвратить некорректные изменения попадающие в репозиторий.
Для использования git hooks необходимо перейти в директорию вашего локального репозитория и перейти в папку «.git/hooks». В ней вы найдете все доступные git hooks.
Примеры наиболее часто используемых git hooks:
- pre-commit — запускается перед созданием коммита. Позволяет проверить код перед его отправкой в репозиторий.
- pre-push — запускается перед отправкой изменений на удаленный сервер. Позволяет выполнить дополнительные проверки, например, запустить тесты перед отправкой.
- post-commit — запускается после коммита. Обычно выполняет дополнительные действия после создания коммита.
- post-merge — запускается после слияния изменений из другой ветки. Позволяет выполнить дополнительные действия после слияния.
Для использования git hooks необходимо создать скрипт с нужным именем в директории «.git/hooks», который будет содержать нужные команды и логику. Примером скрипта может быть выполнение проверки кода, запуск тестов или выполнение каких-либо действий после коммита.
Git hooks могут значительно упростить и автоматизировать процесс разработки, позволяя контролировать и настраивать различные аспекты работы с репозиторием. Они также могут помочь соблюдать кодовые стандарты и предотвращать некорректные изменения, что в свою очередь сказывается на качестве и надежности проекта.
Работа с git hooks в командной строке
1. Внутри вашего Git-репозитория откройте папку hooks. Она находится по пути .git/hooks. Если папка hooks не существует, вам нужно ее создать.
2. В папке hooks будут находиться файлы-шаблоны для разных git hooks. Выберите нужные вам git hooks и скопируйте соответствующие файлы с префиксом sample-. Например, для предкоммит-хука скопируйте файл pre-commit.sample.
3. Удалите предварительный префикс sample- из имени файла, чтобы Git мог его использовать.
4. Откройте скопированный файл в любом текстовом редакторе и внесите необходимые изменения.
5. Сохраните изменения и закройте файл.
6. Выполните команду chmod +x <имя_файла>, чтобы сделать файл исполняемым. Здесь <имя_файла> — это имя файла без префикса sample-.
7. Теперь git будет автоматически выполнять вашу настроенную команду в определенный момент жизненного цикла Git, соответствующий выбранному git hook.
Примеры git hooks, с которыми вы можете работать:
pre-commit— запускается перед каждым коммитом, позволяет проверить код на соответствие определенным стандартам.pre-push— запускается перед каждым пушем, позволяет провести автоматическую проверку перед отправкой изменений на удаленный сервер.post-commit— запускается после каждого коммита, позволяет выполнять дополнительные действия, такие как отправка уведомлений и обновление базы данных.post-checkout— запускается после переключения ветки, позволяет выполнять дополнительные действия для обновления рабочего каталога.
Использование git hooks позволяет автоматизировать процесс разработки и поддерживать высокое качество кода в вашем проекте. Напишите нужные вам команды для проверки кода или других действий и добавьте их в соответствующие git hooks, чтобы упростить и ускорить работу над проектом.
Обработка ошибок и проблем
При настройке и использовании husky в проекте могут возникать различные проблемы и ошибки. В этом разделе я расскажу о некоторых распространенных проблемах и способах их решения.
1. Не работает pre-commit хук. Если вы замечаете, что pre-commit хук не срабатывает при коммите файлов, то возможно, проблема заключается в настройке husky или в корректном указании пути к исполняемому файлу. Убедитесь, что вы правильно настроили husky в файле package.json и указали правильный путь к исполняемому файлу.
2. Ошибка «Husky > pre-commit hook failed». Если при коммите файлов вы получаете ошибку «Husky > pre-commit hook failed», то это означает, что запущенный скрипт не завершает свою работу успешно. Прежде всего, проверьте код вашего pre-commit скрипта на наличие ошибок. Также убедитесь, что он выполняет все необходимые проверки и операции.
3. Не удается установить husky. Если у вас возникают проблемы при установке husky с помощью npm или yarn, то проверьте версию этих инструментов. В некоторых случаях, обновление инструментов до последней версии может решить проблему с установкой husky.
4. Husky не работает с другими инструментами. В некоторых случаях husky может конфликтовать с другими инструментами или плагинами, которые вы используете в своем проекте. Если у вас возникают проблемы совместимости, попробуйте временно отключить другие инструменты и проверить, работает ли husky в этом случае.
5. Не активируются хуки в новых ветках. Если вы создаете новую ветку в вашем проекте и в ней не активируются хуки, то возможно, проблема заключается в том, что husky не установлен в этой ветке. Убедитесь, что вы установили husky в каждой ветке, включая новые, чтобы обеспечить активацию хуков.
- В случае возникновения любых других ошибок или проблем с husky, рекомендуется обратиться к официальной документации или сообществу разработчиков husky для получения помощи и советов.
- Помните, что настройка и использование husky может быть индивидуальным для каждого проекта, поэтому важно проводить тестирование и проверку работоспособности ваших хуков перед использованием в продакшн-среде.
- Не забывайте делать регулярные резервные копии ваших файлов и настроек, чтобы минимизировать потерю данных при возникновении проблем или ошибок.
Дополнительные возможности и сценарии использования
Настройка husky в проекте не ограничивается только выполнением предопределенных действий перед коммитом или пушем. С помощью husky вы можете настроить сценарии, которые будут выполняться в зависимости от определенных условий или событий.
Ниже представлены некоторые дополнительные возможности и сценарии использования husky:
- Запуск тестов перед коммитом: Вы можете настроить husky таким образом, чтобы перед каждым коммитом запускались тесты вашего проекта, чтобы убедиться, что вносимые изменения не приведут к ошибкам. Это поможет избежать коммита кода с ошибками или неправильным функционалом.
- Автоматическая проверка стиля кодирования: Если в вашем проекте существуют определенные правила оформления кода, вы можете настроить husky для автоматической проверки соответствия этих правил перед коммитом. Это поможет убедиться, что код соответствует заданным стандартам и снизит возможность возникновения проблем, связанных с несоблюдением правил форматирования.
- Запуск сборки перед коммитом: Если ваш проект требует сборки перед коммитом или пушем, husky может быть настроен на автоматический запуск сборки перед выполнением этих действий. Это позволит вам быть уверенными, что только собранный и готовый к развертыванию код будет попадать в репозиторий или на сервер.
- Использование предкоммит-хуков: Помимо предустановленных хуков, вы можете создавать собственные предкоммит-хуки для автоматического выполнения определенных действий перед коммитом. Например, вы можете настроить husky на проверку наличия определенных файлов или директорий, и предотвращать коммиты, если они отсутствуют. Это поможет снизить возможность попадания нежелательного или неполного кода в репозиторий.
Использование дополнительных возможностей и сценариев husky позволяет создать более надежный и удобный процесс разработки, повысить качество и стабильность вашего кода.