1
0
mirror of https://github.com/bia-technologies/precommit4onec.git synced 2024-12-30 21:19:59 +02:00
precommit4onec/docs/ПроверкаСообщенияКоммита.md
2024-11-22 08:56:11 +03:00

2.3 KiB

Функциональность проверки сообщения коммита

Описание

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

Настройка

Пример:

{
    "Precommt4onecСценарии": {
        "ПроверкаСообщенияКоммита": {
            "Использовать": true,
            "Выражение": "Задача: \d+, Сообщение: \w+",
            "СообщениеОбОшибке": "Сообщение коммита не содержит номера задачи"
        }
    }
}

Описание параметров:

  • Использовать - Булево - флаг включения проверки соообщений коммита;
  • Выражение - Строка - регулярное выражение, которому должно соответствовать сообщение коммита;
  • СообщениеОбОшибке - Строка - текст сообщения, которое будет показано пользователю при несоответствии сообщения коммита выражению проверки.

Например, при указанной выше настройке, если пользователь введет сообщение "Задача: 1234, Соообщение: Рефакторинг", то проверка пройдет без ошибки. Если сообщение "Рефакторинг по задаче", то при коммите будет выдано сообщение об ошибке "Сообщение коммита не содержит номера задачи".

Настройка осуществляется в файле v8config.json репозитория. Если файл локальных настроек отсутствует, используются глобальные настройки прекоммита.

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