Как использовать хаски для проверки формата сообщения git commit?

Question

Я пытаюсь применить политику сообщения git commit, чтобы мои репозитории были чистыми и аккуратными. Я видел официальные документы об ошибках на стороне сервера и клиента, а затем я столкнулся с husky.

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

Может кто-нибудь объяснить, как я могу настроить хрипло, чтобы проверить мои сообщения о совершении или даже привести пример?

Это мой совершить-сообщ крюк в project-root/githooks папке:

#!/usr/bin/env ruby 

message_file = ARGV[0] 
message = File.read(message_file) 

$regex = /([resolved|fixed]) #([0-9])* ([A-Z])\w+/ 

if !$regex.match(message) 
    puts "[POLICY] Your message is not formatted correctly!" 
    puts "Message format must be like:" 
    puts "resolved #123 Case title (for features)" 
    puts "fixed #123 Case title (for bugs)" 
    puts "First letter of 'Case title' must be capitalized!" 
    exit 1 
end 

Я пытался добавить сценарий к package.json:

"scripts": { 
    ... : ..., 
    "commitmsg": "sh hooks/commit-msg", 
    ... : ... 
} 

крючок не работает. Все сообщения проходят. Если положить в .git/hooks, он работает нормально.

Вот скриншот тестового проекта с package.json, коммит-сообщ крюк и ошибка он выдает.

Тот же крюк, вложенный .git/hooks папка, работает просто отлично.

Answer 1

См issue 81

Во-первых, проверьте

npm config get ignore-scripts # should be false 

Тогда в мерзавца репо:

npm install husky --save-dev 

Вы можете добавить крючки (здесь перед фиксацией и предварительно нажать) для npm (package.json), идея определения этих крюков - это версии в этом файле package.json (часть ваших источников репозитория git)

Вы также можете объявить существующие регулярные крюки Баш (issue 92)

{ 
    "scripts": { 
    "precommit": "sh scripts/my-specific-hook.sh" 
    } 
} 

Вы можете использовать validate-commit-msg для подтверждения своих намерений.

добавить "commitmsg": "validate-commit-msg" в свои npm-скрипты в package.json.