Merge pull request #3 from db-ui/feature/pre_commit_hooks

feat: Pre-Commit hooks

Author: tkoecher

.env.template

@@ -0,0 +1,2 @@
+# It will force the user to add an e-mail for this project, before committing.
+[email protected]

.gitignore

@@ -3,6 +3,9 @@
 .idea
 .vscode
 .kotlin
+
+.env
+
 /local.properties
 .DS_Store
 /build

build.gradle.kts

@@ -3,4 +3,13 @@ plugins {
     alias(libs.plugins.com.android.library) apply false
     alias(libs.plugins.jetbrains.kotlin.android) apply false
     alias(libs.plugins.compose.compiler) apply false
-}
+}
+task<Copy>("installGitHook") {
+    delete(".git/hooks/pre-commit")
+
+    fileMode = 0x777
+    from(File(rootProject.rootDir, "scripts/pre-commit"))
+    into(File(rootProject.rootDir, ".git/hooks"))
+}
+
+tasks.getByPath(":app:preBuild").dependsOn(":installGitHook")

scripts/check-commit-mail.js

@@ -0,0 +1,30 @@
+#!/usr/bin/env node
+import * as ChildProcess from 'node:child_process';
+import * as process from 'node:process';
+
+const checkCommitMail = () => {
+	console.warn(`Check COMMIT_MAIL`);
+	if (!process.env.COMMIT_MAIL) {
+		console.error(
+			`No COMMIT_MAIL set in .env, please take a look at the file '.env.template'`
+		);
+		process.exit(1);
+	}
+
+	const currentMail = ChildProcess.execSync('git config user.email')
+		.toString()
+		.trim()
+		.toLowerCase();
+	const commitMail = process.env.COMMIT_MAIL.trim().toLowerCase();
+	if (currentMail !== commitMail) {
+		console.error(
+			`currentMail: ${currentMail} !== initialMail: ${commitMail}`
+		);
+		console.error(
+			`Please set your commit user mail for this project like: 'git config user.email '${commitMail}''`
+		);
+		process.exit(1);
+	}
+};
+
+checkCommitMail();

scripts/pre-commit

@@ -0,0 +1,17 @@
+#!/bin/sh
+
+git stash -q --keep-index
+
+echo "Running git pre-commit hook"
+
+./gradlew lint &&
+node --env-file=.env ./scripts/check-commit-mail.js &&
+node ./scripts/validate-branch-name.js
+
+RESULT=$?
+
+git stash pop -q
+
+# return 1 exit code if running checks fails
+[ $RESULT -ne 0 ] && exit 1
+exit 0

scripts/validate-branch-name.js

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+import * as ChildProcess from 'node:child_process';
+import * as process from 'node:process';
+
+const checkValidBranchName = () => {
+	console.warn(`Check VALID_BRANCH_NAME`);
+
+    const currentBranchName = ChildProcess.execSync('git symbolic-ref --short HEAD')
+    		.toString()
+    		.trim()
+
+    const regex = /^(feature|fix|hotfix|release)\/.+$/g;
+    const found = currentBranchName.match(regex) !== null;
+	process.exit(found ? 0 : 1);
+};
+
+checkValidBranchName();