feat: add conventional-pre-commit file

Author: Atiqur Rahman

detekt.gradle

@@ -17,3 +17,15 @@ task createDetektPreCommitHook() {
 """
     "chmod +x .git/hooks/pre-commit".execute()
 }
+
+task createConventionalMessagePreCommitHook() {
+    def gitHooksDirectory = new File("$project.rootDir/.git/hooks/")
+    if (!gitHooksDirectory.exists()) gitHooksDirectory.mkdirs()
+    new File("$project.rootDir/.git/hooks", "commit-msg").text = """
+    #!/bin/bash
+    echo "Running Conventional Commit check"
+    commit_message="\$1"
+    ./scripts/conventional-pre-commit.sh "\$commit_message"
+"""
+    "chmod +x .git/hooks/commit-msg".execute()
+}

scripts/conventional-pre-commit.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+if ! grep -qE "^\bbuild\b|\bchore\b|\bci\b|\bdocs\b|\bfeat\b|\bfix\b|\bperf\b|\brefactor\b|\brevert\b|\bstyle\b|\btest\b(\([a-z ]+\)!)?: [\w ]+$" "$1"; then
+    cat $1
+    echo "
+Your commit message doesn't conform to Convential Commit Rules (https://www.conventionalcommits.org/).
+At a minimum, your commit should start with one of the below keywords:
+build: chore: ci: docs: feat: fix: perf: refactor: revert: style: test:
+Example commit message to add a feature: 'feat: Changed something to add a lovely new feature'
+Example commit message to fix an issue: 'fix: Removed infinite loop causing that annoying bug'
+"
+    exit 1
+fi