Merge pull request #8 from lumapps/chore/precommit_hook

chore(script): check message during commit

Author: Anis

.pre-commit-config.yaml

@@ -1,5 +1,12 @@
 ---
 repos:
+  - repo: ./
+    rev: master
+    hooks:
+      - id: commit-message-validator
+        stages: [commit-msg]
+        args: [--no-jira, --allow-temp]
+
   - repo: https://github.com/adrienverge/yamllint.git
     rev: v1.24.2
     hooks:

.pre-commit-hooks.yaml

@@ -0,0 +1,6 @@
+---
+- id: commit-message-validator
+  name: Commit Message Validator
+  description: Checks that commit messages are compliant with Lumapps rules.
+  entry: check_message.sh
+  language: script

Makefile

@@ -13,6 +13,7 @@ pre-commit=./venv/bin/pre-commit
 venv:
 	python3.7 -m venv venv
 	$(pip) install pre-commit
+	$(pre-commit) install -t commit-msg
 
 lint:
 	$(pre-commit) run --all-files

README.md

@@ -247,6 +247,30 @@ jobs:
 - if `no_jira` is not empty, no validation is done on JIRA refs.
 - if `allow_temp` is not empty, no validation is done on `fixup!` and `squash!` commits.
 
+## Add pre-commit plugin
+
+If you are using [pre-commit](https://pre-commit.com/) in you repository, you can add this to your configuration so commit messages are checked locally:
+
+Into `.pre-commit-config.yaml`:
+```yaml
+...
+repos:
+...
+- repo: https://github.com/lumapps/commit-message-validator
+  rev: master
+  hooks:
+    - id: commit-message-validator
+      stages: [commit-msg]
+      args: [--allow-temp]
+...
+```
+Then run `pre-commit install --hook-type commit-msg` to install the `commit-message-validator`
+
+### OPTIONS
+
+- if `no_jira` is set, no validation is done on JIRA refs.
+- if `allow_temp` is set, no validation is done on `fixup!` and `squash!` commits.
+
 <!-- ROADMAP -->
 
 ## Roadmap

check_message.sh

@@ -0,0 +1,49 @@
+#!/usr/bin/env bash
+
+set -eu
+
+OPTIONS=$(getopt --long no-jira allow-temp -- "$@")
+[ $? -eq 0 ] || {
+    echo "Incorrect options provided"
+    exit 1
+}
+
+COMMIT_VALIDATOR_ALLOW_TEMP=
+COMMIT_VALIDATOR_NO_JIRA=
+
+while true; do
+  case "$1" in
+    --no-jira ) COMMIT_VALIDATOR_NO_JIRA=1; shift ;;
+    --allow-temp ) COMMIT_VALIDATOR_ALLOW_TEMP=1; shift ;;
+    -- ) shift; break ;;
+    * ) break ;;
+  esac
+done
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+# shellcheck source=validator.sh
+source "$DIR/validator.sh"
+
+
+if [[ "$1" == *MERGE_MSG ]]
+then
+  # ignore merge message (merge with --no-ff without conflict)
+  exit
+fi
+
+MESSAGE=$(<"$1")
+
+FIRST_WORD=${MESSAGE%% *}
+if [[ "${FIRST_WORD,,}" == merge ]]
+then
+   # ignore merge commits (merge after conflict resolution)
+  exit
+
+fi
+
+# print message so you don't lose it in case of errors
+# (in case you are not using `-m` option)
+echo "Options: JIRA=$COMMIT_VALIDATOR_NO_JIRA, TEMP=$COMMIT_VALIDATOR_ALLOW_TEMP"
+printf "checking commit message:\n\n#BEGIN#\n%s\n#END#\n\n" "$(grep -v "#" <<< "$MESSAGE")"
+
+validate "$MESSAGE"