commit-msg

#!/bin/bash
#===============================================================================
#
#          FILE: commit-msg
#
#         USAGE: ./commit-msg commit_file
#
#   DESCRIPTION: Validates whatever a commit follows the Conventional Commit Guidelines
#
#       OPTIONS: ---
#  REQUIREMENTS: ---
#          BUGS: ---
#         NOTES: ---
#        AUTHOR: ---, 
#  ORGANIZATION: ---
#       CREATED: 09/27/2021 01:24:48 AM
#      REVISION: 2021-10-29 15:11
#===============================================================================
set -o nounset

function main(){
  __TEMP=$(cat $1)
  COMMIT_MSG=$(awk 'NR==1' $1)
  CONVENTIONAL_REGEX="^(?:perf|build|test|refactor|feat|ci|fix|docs|chore|style)!?(?:\([\w\s]+\))?:\s[\s\d\w&]+(?!\.)$"
  IGNORE_FLAG="^\!{2}" 

  [[ $COMMIT_MSG =~ $IGNORE_FLAG ]] && echo "${__TEMP:2}" > $1 && echo "IGNORING CONVENTIONAL COMMIT RULES..." && exit 0
  [[ -z $(echo $COMMIT_MSG | grep -P $CONVENTIONAL_REGEX ) ]] && saveBackup $1 && conventionalError
  [[ ${#COMMIT_MSG} -gt 72 ]] && saveBackup $1 && conventionalError
  exit 0;
}

function conventionalError() {
  cat << EOF
  ------------------------------------------------------
  | PLEASE FOLLOW THE CONVENTIONAL COMMIT GUIDELINES   |
  |                                                    |
  | 1) Start with -> refactor | feat | ci | fix | docs |
  |    chore | style | test | perf | build             |
  |                                                    |
  | 2) Add an optional \`(scope)\` after rule #1       |
  |                                                    |
  | 3) The title should contain less than 73 characters|
  |                                                    |
  | 4) Add a short description                         |
  |                                                    |
  | 5) You could add a body and footer if u want       |
  ------------------------------------------------------
  
  Start the commit message with !! to ignore all the rules. Note: The !! will be automatically removed
  
  Type \`git commit\` and fix the previous commit message ~
EOF

  exit 1;
}

function saveBackup() {
  CLOG=/var/run/user/$UID/last_commit.log
  [[ -e  $CLOG ]] && rm $CLOG
  cp $1 /var/run/user/$UID/last_commit.log 
} > /dev/null

main $@