go-commitlint/README.MD

Commit-lint tool

Программа на Go для проверки описаний коммитов на соответствие соглашению о коммитах.

Использование

Добавить git hook commit-msg:

#!/usr/bin/env sh
commitlint -commitMessage="$1" -config="commitlint.json"

Параметр	Описание	По-умолчанию
-commitMessage	Путь до файла сообщения коммита	.git/COMMIT_EDITMSG
-config	Путь до файла настроек	commitlint.json

Настройка

Настройка по-умолчанию считывается из файла commitlint.json, который находится в корне репозитория

{
  "types": [ "build", "docs", "pref", "refac", "revert", "style", "test" ],
  "contexts": [ "git", "ide" ],
  "excludes": [ "^wip$" ],
  "maxLengthLine": 72
}

Настройка	Описание
types	Перечисление допустимых типов коммитов
contexts	Перечисление допустимых контекстов
excludes	Перечисление шаблонов для исключений
maxLengthLine	Максимальная длинна первой строки коммита

Сборка

Для Linux:

make build-linux

Для Windows:

make build-windows