Added pre-commit hook checking spotless

README.md

@@ -182,6 +182,11 @@ try {
 We're happy to incorporate all improvements to JPlag into this codebase. Feel free to fork the project and send pull requests.
 Please consider our [guidelines for contributions](https://github.com/jplag/JPlag/wiki/3.-Contributing-to-JPlag).
 
+### Git hooks
+
+The repository contains a pre-commit hook, that prevents commits if fail spotless.
+To set up the hooks, call any of the installHooks scrips in gitHooks (gitHooks/installHooks (shell), gitHooks/installHooks.bat (windows), gitHooks/installHooks.py (python))
+
 ## Contact
 If you encounter bugs or other issues, please report them [here](https://github.com/jplag/jplag/issues).
 For other purposes, you can contact us at [email protected] .

gitHooks/hooks/pre-commit

@@ -0,0 +1,42 @@
+#!/bin/sh
+
+echo "Running pre commit checks"
+
+hasJavaFiles=0
+hasJsFiles=0
+
+files=`git diff --name-only --cached`
+while read name
+do
+  if [[ $name == report-viewer* ]]
+  then
+    hasJsFiles=1
+  fi
+
+  if [[ $name == *.java ]]
+  then
+    hasJavaFiles=1
+  fi
+done <<< "$files"
+
+if [[ $hasJsFiles -gt 0 ]]
+then
+  echo "Running report viewer pre commit checks"
+  cd report-viewer
+  ../gitHooks/scripts/reportViewerPreCommit
+  if [ $? -gt 0 ]
+  then
+    exit 1
+  fi
+  cd ..
+fi
+
+if [[ $hasJavaFiles -gt 0 ]]
+then
+  echo "Running java pre commit checks"
+  gitHooks/scripts/javaPreCommit
+  if [ $? -gt 0 ]
+  then
+    exit 1
+  fi
+fi

gitHooks/installHooks.bat

@@ -0,0 +1 @@
+git config --local core.hooksPath gitHooks/hooks

gitHooks/installHooks.py

@@ -0,0 +1,5 @@
+#!/bin/python
+
+import subprocess
+
+subprocess.run(["git", "config", "--local", "core.hooksPath", "gitHooks/hooks"])

gitHooks/installHooks.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+git config --local core.hooksPath gitHooks/hooks

gitHooks/scripts/javaPreCommit

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+if ! command -v <the_command> &> /dev/null #checks if maven is installed
+then
+    echo "Maven is not installed. Spotless will not be checked"
+    exit 0
+fi
+
+#prevents the shell from aborting if maven returns a non zero exit code
+set +e
+echo Checking spotless
+mvn spotless:check &> /dev/null
+exitCode=$?
+
+if [ $exitCode -gt 0 ]
+then
+	echo "Spotless failed. Please run 'mvn spotless:apply' to fix."
+fi
+exit $exitCode

gitHooks/scripts/reportViewerPreCommit

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+npx lint-staged

report-viewer/package.json

@@ -16,7 +16,7 @@
     "type-check": "vue-tsc --noEmit -p tsconfig.vitest.json --composite false",
     "lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix --ignore-path .gitignore --max-warnings 0",
     "format": "prettier --write src/",
-    "prepare": "cd .. && husky report-viewer/.husky"
+    "prepare": "git config --local core.hooksPath gitHooks/hooks"
   },
   "dependencies": {
     "@fortawesome/fontawesome-svg-core": "^6.6.0",
@@ -49,7 +49,6 @@
     "autoprefixer": "^10.4.19",
     "eslint": "^8.57.0",
     "eslint-plugin-vue": "^9.27.0",
-    "husky": "^9.1.4",
     "jsdom": "^24.1.1",
     "lint-staged": "^15.2.7",
     "npm-run-all": "^4.1.5",