Lint-staged является инструментом, который позволяет запускать линтинг и другие проверки на измененных файлах перед коммитом в системе контроля версий. Это полезно, потому что позволяет обнаруживать и исправлять проблемы кода до того, как код будет отправлен на сервер.
Чтобы настроить lint-staged, вам понадобится несколько шагов:
1. Установите пакет lint-staged в свой проект, выполнив следующую команду в терминале:
npm install lint-staged --save-dev
2. Добавьте следующую секцию в ваш файл package.json:
"lint-staged": {
"*.js": "eslint"
}
Здесь мы указываем, что мы хотим запустить ESLint на всех файлах с расширением .js, но вы можете настроить это по вашему усмотрению, добавив другие расширения файлов или инструменты для проверки.
3. Добавьте скрипт pre-commit в секцию "scripts" вашего package.json:
"scripts": {
"pre-commit": "lint-staged"
}
Этот скрипт будет запускать lint-staged перед каждым коммитом.
4. Настройте инструменты проверки и форматирования кода, которые вы хотите использовать. В данном примере мы используем ESLint, но вы можете использовать любой другой инструмент, также как и инструменты форматирования кода, такие как Prettier. Установите соответствующие плагины и настройте их согласно документации.
5. Теперь, когда вы собираетесь сделать коммит, lint-staged будет автоматически запускать ESLint (или другие инструменты, которые вы настроили) на всех измененных файлах перед тем, как они будут закоммичены. Если ESLint найдет какие-либо ошибки или предупреждения, commit не выполнится, пока эти проблемы не будут исправлены.
Это основные шаги по настройке lint-staged. Вы можете дополнительно изменить конфигурацию, чтобы установить требования по форматированию кода, запускать другие инструменты проверки или задать другие сценарии перед коммитом. Детальную информацию о том, как настроить lint-staged дальше, вы можете найти в документации пакета lint-staged на сайте npm или на GitHub.