refactor: added pre-commit tests (#22)

Author: mfranzke

.env.template

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

.gitignore

@@ -14,3 +14,5 @@ dist/
 source/js/*.min.js*
 tests/backstop_data/html_report/
 tests/backstop_data/bitmaps_test/
+
+.env

.husky/pre-commit

@@ -4,3 +4,5 @@
 . "$(dirname "$0")/_/husky.sh"
 
 npx --yes pretty-quick --staged
+npm run lint
+node ./scripts/check-commit-mail.mjs

.prettierrc.json

@@ -1,3 +1,4 @@
 {
-	"trailingComma": "none"
+	"trailingComma": "none",
+	"singleQuote": true
 }

CONTRIBUTING.md

@@ -1,3 +1,11 @@
+# Contributing
+
 Thanks for your interest in our project. Contributions are welcome. Feel free to [open an issue](https://github.com/db-ui/core/issues/new) with questions or reporting ideas and bugs, or [open pull requests](https://github.com/db-ui/core/compare) to contribute code.
 
 We are committed to fostering a welcoming, respectful, and harassment-free environment. Be kind!
+
+## Before you commit
+
+Please make sure that husky is installed correctly to validate your changes.
+
+Moreover, you need to duplicate `.env.template` as `.env` and type your own email address. This ensures that you have the correct email set for this project.

package-lock.json

@@ -73,6 +73,7 @@
     "cpr": "^3.0.1",
     "details-element-polyfill": "^2.4.0",
     "dialog-polyfill": "^0.5.6",
+    "dotenv": "^16.0.2",
     "html-validate": "^6.4.0",
     "html5-boilerplate": "^8.0.0",
     "husky": "^7.0.4",

package.json

@@ -0,0 +1,33 @@
+#!/usr/bin/env node
+import * as ChildProcess from 'node:child_process';
+import * as process from 'node:process';
+import * as dotenv from 'dotenv';
+
+dotenv.config();
+
+const checkCommitMail = () => {
+	console.log(`Check COMMIT_MAIL`);
+	if (!process.env.COMMIT_MAIL) {
+		console.error(
+			`No COMMIT_MAIL set in .env, please 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();