Merge pull request #23 from rest-for-physics/lobis-pre-commit

Implement pre-commit checks and format files

.cmake-format.yaml

@@ -0,0 +1,6 @@
+# https://cmake-format.readthedocs.io/en/latest/configuration.html
+
+format:
+  tab_size: 4
+  separate_ctrl_name_with_space: true
+  separate_fn_name_with_space: false

.github/workflows/validation.yml

@@ -21,15 +21,15 @@ defaults:
 jobs:
   framework-validation:
     uses: rest-for-physics/framework/.github/workflows/validation.yml@master
-  
+
   libCheck:
     name: Validate library
     runs-on: ubuntu-latest
     container:
       image: ghcr.io/lobis/root-geant4-garfield:rest-for-physics
     steps:
       - uses: actions/checkout@v3
-      - run:  python3 pipeline/validateLibrary.py .
+      - run: python3 pipeline/validateLibrary.py .
 
   build-connectorslib:
     name: Build only connectorslib
@@ -43,6 +43,10 @@ jobs:
         with:
           cmake-flags: "-DCMAKE_INSTALL_PREFIX=${{ env.REST_PATH }} -DCMAKE_BUILD_TYPE=${{ env.CMAKE_BUILD_TYPE }} -DREST_WELCOME=ON -DRESTLIB_CONNECTORS=ON"
           branch: ${{ env.BRANCH_NAME }}
+      - name: Verify pre-commit config files match
+        run: |
+          cd $GITHUB_WORKSPACE
+          curl https://raw.githubusercontent.com/rest-for-physics/framework/master/scripts/validatePreCommitConfig.py | python
       - name: Load REST libraries
         run: |
           source ${{ env.REST_PATH }}/thisREST.sh

.gitlab-ci.yml

@@ -28,4 +28,3 @@ Validate Library:
   except:
     variables:
       - $CRONJOB == "YES"
-

.pre-commit-config.yaml

@@ -0,0 +1,35 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-yaml
+      - id: check-xml
+      - id: requirements-txt-fixer
+      - id: end-of-file-fixer
+        exclude: external/.*$
+      - id: mixed-line-ending
+        exclude: external/.*$
+      - id: trailing-whitespace
+        exclude: external/.*$
+
+  - repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: v15.0.6
+    hooks:
+      - id: clang-format
+        exclude: external/.*$
+
+  - repo: https://github.com/cheshirekow/cmake-format-precommit
+    rev: v0.6.13
+    hooks:
+      - id: cmake-format
+        additional_dependencies: [ pyyaml ]
+      # - id: cmake-lint
+
+  - repo: https://github.com/psf/black
+    rev: 22.12.0
+    hooks:
+      - id: black

CMakeLists.txt

@@ -6,11 +6,14 @@ set(excludes)
 set(deps detector geant4 track raw)
 if (NOT ${RESTLIB_RAW} MATCHES "ON")
     list(REMOVE_ITEM deps raw)
-    set(excludes ${excludes} TRestDetectorSignalToRawSignalProcess TRestRawReadoutAnalysisProcess TRestRawToDetectorSignalProcess)
+    set(excludes ${excludes} TRestDetectorSignalToRawSignalProcess
+                 TRestRawReadoutAnalysisProcess TRestRawToDetectorSignalProcess)
 endif ()
 if (NOT ${RESTLIB_TRACK} MATCHES "ON")
     list(REMOVE_ITEM deps track)
-    set(excludes ${excludes} TRestDetectorHitsToTrackProcess TRestDetectorHitsToTrackFastProcess TRestTrackToDetectorHitsProcess)
+    set(excludes
+        ${excludes} TRestDetectorHitsToTrackProcess
+        TRestDetectorHitsToTrackFastProcess TRestTrackToDetectorHitsProcess)
 endif ()
 if (NOT ${RESTLIB_GEANT4} MATCHES "ON")
     list(REMOVE_ITEM deps geant4)
@@ -19,9 +22,12 @@ endif ()
 
 list(LENGTH deps ndeps)
 if (NOT ${ndeps} MATCHES 1)
-    COMPILELIB(deps)
+    compilelib(deps)
 else ()
-    message(WARNING "Library RESTConnectors requires at least one active library (${deps})")
+    message(
+        WARNING
+            "Library RESTConnectors requires at least one active library (${deps})"
+    )
 endif ()
 
-ADD_LIBRARY_TEST()
+add_library_test()

inc/TRestDetectorHitsToTrackFastProcess.h

@@ -53,8 +53,8 @@ class TRestDetectorHitsToTrackFastProcess : public TRestEventProcess {
 
         RESTMetadata << " Cell resolution : " << fCellResolution << " mm " << RESTendl;
         RESTMetadata << " Net size : " << fNetSize << " mm " << RESTendl;
-        RESTMetadata << " Net origin : ( " << fNetOrigin.X() << " , " << fNetOrigin.Y() << " , " << fNetOrigin.Z()
-                 << " ) mm " << RESTendl;
+        RESTMetadata << " Net origin : ( " << fNetOrigin.X() << " , " << fNetOrigin.Y() << " , "
+                     << fNetOrigin.Z() << " ) mm " << RESTendl;
         RESTMetadata << " Number of nodes (per axis) : " << fNodes << RESTendl;
 
         EndPrintProcess();

inc/TRestRawReadoutAnalysisProcess.h

@@ -14,7 +14,7 @@
 
 #include <TH1D.h>
 
-//#include <TCanvas.h>
+// #include <TCanvas.h>
 
 #include <TRestDetectorGas.h>
 #include <TRestDetectorHitsEvent.h>

inc/TRestRawToDetectorSignalProcess.h

@@ -90,10 +90,10 @@ class TRestRawToDetectorSignalProcess : public TRestEventProcess {
         RESTMetadata << "Gain : " << fGain << RESTendl;
 
         if (fZeroSuppression) {
-            RESTMetadata << "Base line range definition : ( " << fBaseLineRange.X() << " , " << fBaseLineRange.Y()
-                     << " ) " << RESTendl;
-            RESTMetadata << "Integral range : ( " << fIntegralRange.X() << " , " << fIntegralRange.Y() << " ) "
-                     << RESTendl;
+            RESTMetadata << "Base line range definition : ( " << fBaseLineRange.X() << " , "
+                         << fBaseLineRange.Y() << " ) " << RESTendl;
+            RESTMetadata << "Integral range : ( " << fIntegralRange.X() << " , " << fIntegralRange.Y()
+                         << " ) " << RESTendl;
             RESTMetadata << "Point Threshold : " << fPointThreshold << " sigmas" << RESTendl;
             RESTMetadata << "Signal threshold : " << fSignalThreshold << " sigmas" << RESTendl;
             RESTMetadata << "Number of points over threshold : " << fNPointsOverThreshold << RESTendl;

pipeline/clang-format/clang-format.sh

@@ -106,4 +106,3 @@ if [ "-" = "$1" ] ; then
 																																																																																																		  }"' '"${file}"'
 																																																																																																	  done
 																																																																																																  fi
-

pipeline/clang-format/clangformattest.sh

@@ -52,4 +52,3 @@ fi
 git reset HEAD --hard
 
 exit 1
-