Merge pull request #76 from rust-practice/conventional-commits-hook

chore: add scripts to help setup recommended hooks

Author: pawarherschel

scripts/commit-msg

@@ -0,0 +1,15 @@
+#!/bin/sh
+
+regex="^(feat|fix|build|chore|ci|docs|style|refactor|perf|test)(\[.+\])?: .+"
+
+grep -E "$regex" "$1"
+if [ $? != 0 ]
+then
+    echo "[error] Commit message doesn't appear to in the conventional commit format"
+    echo "[info] expecting \"<type>[optional scope]: <description>\""
+    echo "[info] see https://www.conventionalcommits.org/en/v1.0.0/#summary for more info"
+    echo "[debug] using regex: \"$regex\""
+    echo "[debug] on commit message:"
+    cat "$1"
+    exit 1
+fi

scripts/hooks_setup.bat

@@ -0,0 +1,6 @@
+@echo off
+@REM Expected to be run from the scripts folder
+
+copy commit-msg ..\.git\hooks\
+
+if %ERRORLEVEL% NEQ 0 echo [error] The copy seems to have failed. This script expects to be run from inside the scripts folder

scripts/hooks_setup.sh

@@ -0,0 +1,11 @@
+#!/bin/sh
+
+# Expected to be run from the scripts folder
+
+cp commit-msg ../.git/hooks/
+
+if [ $? != 0 ]
+then
+    echo "[error] The copy seems to have failed. This script expects to be run from inside the scripts folder"
+    exit 1
+fi