Merge pull request #1881 from jplag/feature/gitPreCommit

Added pre-commit hook checking spotless

docs/3.-Contributing-to-JPlag.md

@@ -20,3 +20,8 @@ Please try to make well-documented and clear structured submissions:
    Run `mvn clean package assembly:single` instead if you need the full jar which includes all dependencies.
 5. You will find the generated JARs in the subdirectory `jplag.cli/target`.
 
+### Git hooks
+
+The repository contains a pre-commit hook, that prevents commits if fail spotless.
+To set up the hooks, call `git config --local core.hooksPath gitHooks/hooks` once within your local repository.
+

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/scripts/javaPreCommit

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+if ! command -v mvn &> /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,9 @@
+#!/bin/bash
+
+if ! command -v npm &> /dev/null #checks if npm is installed
+then
+    echo "Npm is not installed. Linter check will be skipped"
+    exit 0
+fi
+
+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.20",
     "eslint": "^8.57.0",
     "eslint-plugin-vue": "^9.27.0",
-    "husky": "^9.1.5",
     "jsdom": "^24.1.1",
     "lint-staged": "^15.2.9",
     "npm-run-all": "^4.1.5",