CI/CD: Integrate pre-commit hooks and GitHub Actions workflow (#303)

To improve codebase quality and reduce human error, this PR introduces
the pre-commit framework. This ensures that all code adheres to project
standards before it is even committed, maintaining a consistent style
and catching common mistakes early.

Key Changes:

- Code Formatting: Automated C++ formatting using clang-format (based on
the project's .clang-format file).
- Syntax Validation: Basic checks for file integrity and syntax.
- Spell Check: Automated scanning for typos in source code and comments.
- CMake Formatting: Standardization of CMakeLists.txt and .cmake
configuration files.
- GitHub Workflow: Added a CI action that validates every Pull Request
against the pre-commit configuration to ensure compliance.

The configuration includes a [ci] block to handle automated fixes within
the PR. Currently, this is disabled. If we want the CI to automatically
commit formatting fixes back to the PR branch, this can be toggled to
true in .pre-commit-config.yaml.

```yaml
ci:
  autofix_commit_msg: [pre-commit] auto fixes from pre-commit hooks
  autofix_prs: false
  autoupdate_schedule: monthly
```

The last large commit with the fit functions, for example, was not
formatted according to the clang-format rules. This PR would allow to
avoid similar mistakes in the future.

Python fomat with `ruff` for tests and sanitiser for `.ipynb` notebooks
can be added as well.

python/CMakeLists.txt

@@ -1,37 +1,38 @@
 # SPDX-License-Identifier: MPL-2.0
 
-find_package (Python 3.10 COMPONENTS Interpreter Development.Module REQUIRED)
+find_package(
+  Python 3.10
+  COMPONENTS Interpreter Development.Module
+  REQUIRED)
 set(PYBIND11_FINDPYTHON ON) # Needed for RH8
 
 # Download or find pybind11 depending on configuration
 if(AARE_FETCH_PYBIND11)
-    FetchContent_Declare(
-        pybind11
-        GIT_REPOSITORY https://github.com/pybind/pybind11
-        GIT_TAG        v2.13.6
-    )
-    FetchContent_MakeAvailable(pybind11)
+  FetchContent_Declare(
+    pybind11
+    GIT_REPOSITORY https://github.com/pybind/pybind11
+    GIT_TAG v2.13.6)
+  FetchContent_MakeAvailable(pybind11)
 else()
-    find_package(pybind11 2.13 REQUIRED)
+  find_package(pybind11 2.13 REQUIRED)
 endif()
 
 # Add the compiled python extension
 pybind11_add_module(
-    _aare           # name of the module
-    src/module.cpp  # source file
-    )
-
-set_target_properties(_aare PROPERTIES
-    LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}
+  _aare # name of the module
+  src/module.cpp # source file
 )
+
+set_target_properties(_aare PROPERTIES LIBRARY_OUTPUT_DIRECTORY
+                                       ${CMAKE_BINARY_DIR})
 target_link_libraries(_aare PRIVATE aare_core aare_compiler_flags)
 
-target_include_directories(_aare SYSTEM PRIVATE
-    $<TARGET_PROPERTY:Minuit2::Minuit2,INTERFACE_INCLUDE_DIRECTORIES>
-)
+target_include_directories(
+  _aare SYSTEM
+  PRIVATE $<TARGET_PROPERTY:Minuit2::Minuit2,INTERFACE_INCLUDE_DIRECTORIES>)
 
 # List of python files to be copied to the build directory
-set( PYTHON_FILES
+set(PYTHON_FILES
     aare/__init__.py
     aare/CtbRawFile.py
     aare/ClusterFinder.py
@@ -42,43 +43,32 @@ set( PYTHON_FILES
     aare/RawFile.py
     aare/transform.py
     aare/ScanParameters.py
-    aare/utils.py
-)
-
+    aare/utils.py)
 
 # Copy the python files to the build directory
 foreach(FILE ${PYTHON_FILES})
-    configure_file(${FILE} ${CMAKE_BINARY_DIR}/${FILE}  )
+  configure_file(${FILE} ${CMAKE_BINARY_DIR}/${FILE})
 endforeach(FILE ${PYTHON_FILES})
 
-set_target_properties(_aare PROPERTIES
-    LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/aare
-)
-
-set(PYTHON_EXAMPLES
-    examples/play.py
-    examples/fits.py
-)
+set_target_properties(_aare PROPERTIES LIBRARY_OUTPUT_DIRECTORY
+                                       ${CMAKE_BINARY_DIR}/aare)
 
+set(PYTHON_EXAMPLES examples/play.py examples/fits.py)
 
 # Copy the python examples to the build directory
 foreach(FILE ${PYTHON_EXAMPLES})
-    configure_file(${FILE} ${CMAKE_BINARY_DIR}/${FILE}  )
-    message(STATUS "Copying ${FILE} to ${CMAKE_BINARY_DIR}/${FILE}")
+  configure_file(${FILE} ${CMAKE_BINARY_DIR}/${FILE})
+  message(STATUS "Copying ${FILE} to ${CMAKE_BINARY_DIR}/${FILE}")
 endforeach(FILE ${PYTHON_EXAMPLES})
 
-
 if(AARE_INSTALL_PYTHONEXT)
-    install(
-        TARGETS _aare
-        EXPORT "${TARGETS_EXPORT_NAME}"
-        LIBRARY DESTINATION aare
-        COMPONENT python
-    )
+  install(
+    TARGETS _aare
+    EXPORT "${TARGETS_EXPORT_NAME}"
+    LIBRARY DESTINATION aare COMPONENT python)
 
-    install(
-        FILES ${PYTHON_FILES} 
-        DESTINATION aare
-        COMPONENT python
-        )
-endif()
+  install(
+    FILES ${PYTHON_FILES}
+    DESTINATION aare
+    COMPONENT python)
+endif()