Проверьте сообщение Commit, используя приятель и хаски

C Сообщение Ommit очень важно, когда вы работаете в команде. Читая обычные коммитируемые сообщения, это помогает вашей команде понять, какие изменения вы сделали, и почему. Когда-нибудь, это также поможет вам, когда вы смотрите в свою кодовую базу 😜. Вы будете использовать Приятель Для проверки сообщения Commit.

ContyLINT проверяет, соответствуют ли ваши сообщения Comparts The Обычный формат фиксации Отказ

Установить приятель:

$ yarn add @commitlint/cli

Есть несколько конвенций, которые мы можем использовать:

1. @ Приятель/конфигурация угловой
2. @ Приборы/конфигурация-обычные ✅.
3. @ Приборы/config-lerra-scopes
4. @ Приборы/config-pattern Phate

Чтобы добавить конфигурацию-обычную в проект,

Установить @ Приборы/конфигурация-обычные :

$ yarn add @commitlint/config-conventional

Создать compictlint.config.js В корне проекта:

compictlint.config.js:

module.exports = {extends: ['@commitlint/config-conventional']};

Конфигурация подбирается из compictlint.config.js или Приятель поле в package.json Отказ

Гитики с хаскими 🐶

Это не собака 😜. Мы говорим о инструменте, который позволяет вам очень легко настроить git крючки.

Вы можете добавить git крючки в два простых шага:

• Установите хаски в качестве зависимости Dev:

  $ yarn add husky

• Вставьте следующий код в свой package.json :

  {
    "husky": {
      "hooks": {
        "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
      }
    }
  }

• Добавить крючок

$ yarn husky add .husky/commit-msg "yarn commitlint --edit $1"

После запуска выше команды вы сможете увидеть .husky в корне проекта.

Это все. В каждом фиксации команда, связанная с Commit-Msg будет запущен. Если вы совершаете с неправильным сообщением Commit, вы получите ошибку ниже, как показано ниже:

Ваш финал package.json будет выглядеть как под фрагментом:

Package.json.

{
  "name": "web",
  "version": "0.0.0",
  "private": true,
  "scripts": {
    ...
  },
  "dependencies": {
    ...
  },
  "devDependencies": {
    "@commitlint/cli": "^12.0.1",
    "@commitlint/config-conventional": "^12.0.1",
    "husky": "^6.0.0"
  },
  "husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  }
}

Примечание: 🧨.

Все зависимости должны быть установлены как зависимости разработки, вам не нужно добавлять непосредственно в зависимости.

Ссылка 🧐.

• Обычный ChangeLog Perylint.

Оригинал: “https://dev.to/suprabhasupi/validate-commit-message-using-commitlint-and-husky-2n5o”