Настройка husky для более эффективного развития вашего проекта

При разработке программного обеспечения часто важно соблюдать единые стандарты и правила кодирования. Они позволяют улучшить читаемость, снизить количество ошибок и облегчить сопровождение проекта. Один из инструментов, который помогает автоматизировать проверку кода, — это Husky.

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

Для использования Husky в проекте необходимо выполнить несколько простых шагов. Во-первых, нужно установить его в качестве зависимости разработки в проекте. Для этого можно воспользоваться менеджером пакетов npm или yarn:

$ npm install husky --save-dev

$ yarn add husky --dev

После установки Husky нужно настроить его в файле package.json. В раздел «scripts» необходимо добавить скрипт «precommit», который будет вызываться перед каждым коммитом. Этот скрипт будет содержать команды для проверки кода:

"scripts": {

  "precommit": "lint"

}

В данном примере используется команда «lint», которая запускает статический анализатор кода. Однако, в зависимости от потребностей проекта, можно настроить любую другую команду для проверки стиля кода, тестирования или других задач.

Шаг 1. Установка husky

Перед началом работы с husky необходимо установить его в свой проект. Для этого выполните следующие шаги:

1. Откройте терминал и перейдите в корневую папку проекта.

2. Введите команду npm install husky —save-dev и нажмите Enter. Эта команда установит husky как зависимость разработки в вашем проекте.

3. После успешной установки husky, в корневой папке проекта появится директория .git/hooks.

4. Теперь, чтобы начать использовать husky, необходимо создать в этой директории файл pre-commit. Для этого выполните команду touch .git/hooks/pre-commit.

5. Откройте созданный файл pre-commit в вашем текстовом редакторе и добавьте необходимые команды или скрипты, которые вы хотите выполнять перед каждым коммитом.

6. Сохраните изменения и закройте файл pre-commit.

Теперь husky установлен и готов к использованию в вашем проекте. В следующем шаге мы настроим его для выполнения задач перед каждым коммитом.

Шаг 2. Создание конфигурационного файла

После установки пакета husky настало время создать конфигурационный файл для его настройки. Для этого выполните следующие шаги:

1. В корневой папке вашего проекта создайте файл с именем .huskyrc. Обратите внимание, что имя файла начинается с точки, что делает его скрытым в файловой системе.
2. Откройте созданный файл с помощью редактора кода и добавьте в него следующий код:

{"hooks": {"pre-commit": "lint-staged"}}

В данном примере мы настраиваем хук pre-commit, который будет вызывать команду lint-staged. Убедитесь, что у вас уже установлен пакет lint-staged, так как в противном случае команда не сработает.

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

После того, как конфигурационный файл создан и настроен, вы можете приступить к следующему шагу — настройке пакета lint-staged.

Шаг 3. Настройка pre-commit хука

Продолжаем настраивать husky в нашем проекте! В этом шаге мы настроим pre-commit хук, который будет запускаться перед каждым коммитом кода в репозиторий.

1. Создание pre-commit скрипта

Для начала создадим файл pre-commit в директории .husky в корне проекта. В этом файле мы опишем команды, которые должны выполниться перед каждым коммитом.

2. Определение команд pre-commit скрипта

В pre-commit скрипте мы можем добавить любые команды, которые должны выполниться перед коммитом. Часто в этом шаге производятся проверки кода на соответствие определенным правилам или запуск тестов проекта. Например:


#!/bin/sh
echo "Running ESLint"
eslint .
echo "Running tests"
npm test


В данном примере мы запускаем eslint для проверки стиля кода, а затем запускаем npm test для запуска тестов проекта. Вы можете заменить эти команды на свои, в зависимости от нужд вашего проекта.

3. Добавление прав на выполнение pre-commit скрипта

После создания pre-commit скрипта, необходимо дать ему права на выполнение. Мы можем сделать это с помощью команды chmod:

chmod +x .husky/pre-commit

4. Проверка работы pre-commit хука

Теперь, при каждом коммите кода в репозиторий, будут автоматически запускаться команды, указанные в pre-commit скрипте. Это позволяет обеспечить непрерывную интеграцию, а также контролировать качество и стиль кода в проекте.

Это был последний шаг настройки husky! Мы успешно настроили pre-commit хук, который будет автоматически запускаться перед каждым коммитом в нашем проекте. Теперь можно приступить к разработке, зная, что наши изменения всегда проходят проверку перед отправкой в репозиторий.

Шаг 4. Настройка pre-push хука

Для настройки pre-push хука, вам понадобится создать файл с именем «pre-push» в папке «.git/hooks» вашего проекта. Это можно сделать с помощью следующей команды в терминале:

touch .git/hooks/pre-push

После создания файла, откройте его в редакторе кода и добавьте следующий скрипт:

#!/bin/sh
npm run lint

В данном случае, мы используем команду «npm run lint» для запуска проверки кода. Вы можете заменить эту команду на любую другую, соответствующую вашим потребностям.

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

chmod +x .git/hooks/pre-push

Теперь pre-push хук настроен и будет автоматически запускаться перед каждой отправкой изменений в удаленный репозиторий. Это позволит вам производить проверку кода перед отправкой и предотвратить отправку ошибочного кода.

В этом разделе мы рассмотрели шаги по настройке pre-push хука в вашем проекте. Следующий шаг — проверка настроенного хука и его работоспособность.

Шаг 5. Использование Git Hooks

Чтобы настроить Husky с использованием Git Hooks, необходимо внести следующие изменения в настройки проекта:

1. Установите Husky в ваш проект с помощью команды npm install husky --save-dev.
2. Откройте файл package.json в корневой папке вашего проекта.
3. Добавьте следующие строки в раздел "scripts":

"pre-commit": "npm run lint","pre-push": "npm run test"

В приведенном выше примере pre-commit и pre-push — это названия Git Hooks, которые будут выполнены до команды commit и push соответственно. Здесь мы используем команды npm run lint и npm run test, чтобы выполнить проверку кода и тестирование перед отправкой изменений в репозиторий.

Затем установите Husky, выполнив команду npx husky install. Она создаст папку .husky в корневой папке вашего проекта и добавит необходимые файлы Git Hooks.

Теперь, при каждом выполнении команды commit или push, Husky будет автоматически запускать соответствующие Git Hooks и выполнять проверку кода и тестирование. Если проверка не пройдена, он прервет выполнение команды и выведет ошибку.

Таким образом, использование Git Hooks с Husky позволяет автоматизировать процесс проверки кода и тестирования, обеспечивая высокое качество кода в вашем проекте.

Шаг 6. Работа с множественными хуками

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

Чтобы работать с множественными хуками, необходимо добавить их в файл package.json в поле «husky». Например, для настройки хука «pre-commit» и «pre-push» нужно добавить следующий код:

"husky": {"hooks": {"pre-commit": "npm run format && npm run lint","pre-push": "npm run test"}}

Здесь мы указываем команды, которые должны выполняться перед каждым коммитом и перед каждым push. В данном примере, перед каждым коммитом будет автоматически форматироваться код с помощью команды «format» и проверяться линтером с помощью команды «lint». Перед каждым push будет выполняться команда «test», которая запустит тесты проекта.

Важно учитывать последовательность выполнения хуков, так как они могут влиять друг на друга. Например, если хук «pre-push» зависит от результатов выполнения хука «pre-commit», то необходимо убедиться, что хук «pre-commit» выполняется первым.

Данный подход позволяет автоматизировать множество действий перед коммитом или push, обеспечивая более надежное и последовательное выполнение задач, а также повышая качество кода и процесс разработки.

Шаг 7. Тестирование husky

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

Для тестирования можно использовать следующие шаги:

1. Сделайте изменения в своем проекте, например, добавьте новый файл или внесите изменения в уже существующий.
2. Попробуйте выполнить команду git add для добавления изменений в индекс.
3. Если husky работает должным образом, команда git add будет выполнена успешно и изменения будут добавлены в индекс.
4. Если husky работает неправильно или вовсе не запускается, команда git add завершится с ошибкой или изменения не будут добавлены в индекс.

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

Тестирование husky в своем проекте – важный шаг для обеспечения правильной работы хуков и успешного использования данного инструмента в повседневной разработке.