Merge pull request PowerGridModel#1196 from PowerGridModel/feature/cmake-linter-precommit

CI: add cmake linter

Author: TonyXiang8787

.gersemirc

@@ -0,0 +1,12 @@
+# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+definitions: [./cmake/stubs/]
+disable_formatting: false
+extensions: []
+indent: 4
+line_length: 80
+list_expansion: favour-inlining
+unsafe: false
+warn_about_unknown_commands: true

.github/workflows/check-code-quality.yml

@@ -52,6 +52,11 @@ jobs:
           sudo apt-get install -y clang-format-18
           find . -regex '.*\.\(h\|c\|cpp\|hpp\|cc\|cxx\)' -exec clang-format-18 -style=file -i {} \;
 
+      - name: Install and run cmake-linter
+        run: |
+          pip install gersemi
+          gersemi -i --warnings-as-errors src/ tests/ cmake/
+
       - name: Install and run markdownlint
         run: |
           npm install -g markdownlint-cli
@@ -95,4 +100,3 @@ jobs:
           else
             echo "The test-workflow.yml file matches main."
           fi
-

.pre-commit-config.yaml

@@ -37,6 +37,12 @@ repos:
     hooks:
       - id: clang-format
         types_or: [ c++, c ]
+  - repo: https://github.com/BlankSpruce/gersemi
+    rev: 0.23.1
+    hooks:
+    - id: gersemi
+      name: cmake-linter
+      alias: cmake-linter
   - repo: https://github.com/igorshubovych/markdownlint-cli
     rev: v0.45.0
     hooks:

CMakeLists.txt

@@ -5,11 +5,11 @@
 # CMakeList.txt : CMake project for power_grid_model, include source and define
 # project specific logic here.
 #
-cmake_minimum_required (VERSION 3.23)
+cmake_minimum_required(VERSION 3.23)
 
 include("cmake/pgm_version.cmake")
 
-project (power_grid_model VERSION ${PGM_VERSION})
+project(power_grid_model VERSION ${PGM_VERSION})
 
 option(PGM_ENABLE_DEV_BUILD "Enable developer build (e.g.: tests)" OFF)
 
@@ -29,9 +29,9 @@ set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 
 include(GNUInstallDirs)
 
-if(CMAKE_VERSION VERSION_GREATER_EQUAL "3.30.0") 
-#  libboost-headers packaged by conda does not come with BoostConfig.cmake
-cmake_policy(SET CMP0167 OLD)  
+if(CMAKE_VERSION VERSION_GREATER_EQUAL "3.30.0")
+    #  libboost-headers packaged by conda does not come with BoostConfig.cmake
+    cmake_policy(SET CMP0167 OLD)
 endif()
 
 find_package(Boost REQUIRED)
@@ -40,24 +40,22 @@ find_package(nlohmann_json CONFIG REQUIRED)
 find_package(msgpack-cxx REQUIRED)
 
 if(NOT WIN32)
-  # thread
-  find_package(Threads REQUIRED)
+    # thread
+    find_package(Threads REQUIRED)
 endif()
 
 # add C library
 add_subdirectory("power_grid_model_c")
 
 # dev build
 if(${PGM_ENABLE_DEV_BUILD})
-  include(CTest)
-  enable_testing()
-  # get tests
-  add_subdirectory("tests")
-  # get c api example
-  add_subdirectory("power_grid_model_c_example")
+    include(CTest)
+    enable_testing()
+    # get tests
+    add_subdirectory("tests")
+    # get c api example
+    add_subdirectory("power_grid_model_c_example")
 endif()
 
-
-
 # export the power grid model
 include("cmake/export_power_grid_model.cmake")

cmake/export_power_grid_model.cmake

@@ -2,35 +2,42 @@
 #
 # SPDX-License-Identifier: MPL-2.0
 
-cmake_minimum_required (VERSION 3.23)
+cmake_minimum_required(VERSION 3.23)
 
 # export the license and readme
-configure_file("${PROJECT_SOURCE_DIR}/cmake/README.md.in" "${CMAKE_CURRENT_BINARY_DIR}/README.md")
-install(FILES "LICENSE" "${CMAKE_CURRENT_BINARY_DIR}/README.md"
-  DESTINATION "share"
+configure_file(
+    "${PROJECT_SOURCE_DIR}/cmake/README.md.in"
+    "${CMAKE_CURRENT_BINARY_DIR}/README.md"
+)
+install(
+    FILES "LICENSE" "${CMAKE_CURRENT_BINARY_DIR}/README.md"
+    DESTINATION "share"
 )
 
 # export the power grid model targets
-install(EXPORT "power_grid_modelTargets"
-  DESTINATION "lib/cmake/power_grid_model"
-  NAMESPACE power_grid_model::
-  COMPONENT power_grid_model
+install(
+    EXPORT "power_grid_modelTargets"
+    DESTINATION "lib/cmake/power_grid_model"
+    NAMESPACE power_grid_model::
+    COMPONENT power_grid_model
 )
 
 # export configuration and version to enable find_package(power_grid_model)
 include(CMakePackageConfigHelpers)
 
-configure_package_config_file("${PROJECT_SOURCE_DIR}/cmake/power_grid_modelConfig.cmake.in"
-  "${CMAKE_CURRENT_BINARY_DIR}/power_grid_model/power_grid_modelConfig.cmake"
-  INSTALL_DESTINATION "lib/cmake/power_grid_model"
+configure_package_config_file(
+    "${PROJECT_SOURCE_DIR}/cmake/power_grid_modelConfig.cmake.in"
+    "${CMAKE_CURRENT_BINARY_DIR}/power_grid_model/power_grid_modelConfig.cmake"
+    INSTALL_DESTINATION "lib/cmake/power_grid_model"
 )
 write_basic_package_version_file(
-  "${CMAKE_CURRENT_BINARY_DIR}/power_grid_model/power_grid_modelConfigVersion.cmake"
-  VERSION ${PGM_VERSION}
-  COMPATIBILITY SameMajorVersion
+    "${CMAKE_CURRENT_BINARY_DIR}/power_grid_model/power_grid_modelConfigVersion.cmake"
+    VERSION ${PGM_VERSION}
+    COMPATIBILITY SameMajorVersion
+)
+install(
+    FILES
+        "${CMAKE_CURRENT_BINARY_DIR}/power_grid_model/power_grid_modelConfig.cmake"
+        "${CMAKE_CURRENT_BINARY_DIR}/power_grid_model/power_grid_modelConfigVersion.cmake"
+    DESTINATION "lib/cmake/power_grid_model"
 )
-install(FILES
-  "${CMAKE_CURRENT_BINARY_DIR}/power_grid_model/power_grid_modelConfig.cmake"
-  "${CMAKE_CURRENT_BINARY_DIR}/power_grid_model/power_grid_modelConfigVersion.cmake"
-  DESTINATION "lib/cmake/power_grid_model"
-)

cmake/pgm_version.cmake

@@ -2,8 +2,14 @@
 #
 # SPDX-License-Identifier: MPL-2.0
 
-cmake_minimum_required (VERSION 3.23)
+cmake_minimum_required(VERSION 3.23)
 
 file(READ "${CMAKE_CURRENT_SOURCE_DIR}/VERSION" _PGM_VERSION)
 string(STRIP ${_PGM_VERSION} _PGM_VERSION_STRIPPED)
-string(REGEX REPLACE "^([0-9]+\\.[0-9]+(\\.[0-9]+)?).*" "\\1" PGM_VERSION "${_PGM_VERSION_STRIPPED}")
+string(
+    REGEX REPLACE
+    "^([0-9]+\\.[0-9]+(\\.[0-9]+)?).*"
+    "\\1"
+    PGM_VERSION
+    "${_PGM_VERSION_STRIPPED}"
+)

cmake/stubs/doctest.cmake

@@ -0,0 +1,10 @@
+# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+cmake_minimum_required(VERSION 3.23)
+
+# stub for doctest_discover_tests
+function(doctest_discover_tests target)
+    # no-op
+endfunction()

power_grid_model_c/power_grid_model/CMakeLists.txt

@@ -4,20 +4,31 @@
 
 add_library(power_grid_model INTERFACE)
 
-target_link_libraries(power_grid_model INTERFACE
-  Eigen3::Eigen Boost::headers msgpack-cxx nlohmann_json::nlohmann_json
+target_link_libraries(
+    power_grid_model
+    INTERFACE
+        Eigen3::Eigen
+        Boost::headers
+        msgpack-cxx
+        nlohmann_json::nlohmann_json
 )
 
 if(Threads_FOUND)
-  target_link_libraries(power_grid_model INTERFACE Threads::Threads)
+    target_link_libraries(power_grid_model INTERFACE Threads::Threads)
 endif()
 
-target_include_directories(power_grid_model INTERFACE "${CMAKE_CURRENT_SOURCE_DIR}/include")
+target_include_directories(
+    power_grid_model
+    INTERFACE "${CMAKE_CURRENT_SOURCE_DIR}/include"
+)
 
 # only use MPL version of eigen
 target_compile_definitions(power_grid_model INTERFACE "EIGEN_MPL2_ONLY=1")
 
-target_compile_options(power_grid_model BEFORE INTERFACE
-  "$<$<CXX_COMPILER_ID:Clang>:-Wno-unknown-attributes>"
-  "$<$<CXX_COMPILER_ID:MSVC>:/bigobj>"
+target_compile_options(
+    power_grid_model
+    BEFORE
+    INTERFACE
+        "$<$<CXX_COMPILER_ID:Clang>:-Wno-unknown-attributes>"
+        "$<$<CXX_COMPILER_ID:MSVC>:/bigobj>"
 )

power_grid_model_c/power_grid_model_c/CMakeLists.txt

@@ -3,49 +3,55 @@
 # SPDX-License-Identifier: MPL-2.0
 
 # C API library
-add_library(power_grid_model_c SHARED
-  "src/buffer.cpp"
-  "src/handle.cpp"
-  "src/meta_data.cpp"
-  "src/model.cpp"
-  "src/options.cpp"
-  "src/dataset_definitions.cpp"
-  "src/serialization.cpp"
-  "src/dataset.cpp"
-  "src/math_solver.cpp"
+add_library(
+    power_grid_model_c
+    SHARED
+    "src/buffer.cpp"
+    "src/handle.cpp"
+    "src/meta_data.cpp"
+    "src/model.cpp"
+    "src/options.cpp"
+    "src/dataset_definitions.cpp"
+    "src/serialization.cpp"
+    "src/dataset.cpp"
+    "src/math_solver.cpp"
 )
 
-target_include_directories(power_grid_model_c PUBLIC
-  $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
-  $<INSTALL_INTERFACE:include>
+target_include_directories(
+    power_grid_model_c
+    PUBLIC
+        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+        $<INSTALL_INTERFACE:include>
 )
 
 file(
-  GLOB_RECURSE
-  pgm_c_public_headers
-  "${CMAKE_CURRENT_SOURCE_DIR}/include/*.h"
+    GLOB_RECURSE pgm_c_public_headers
+    "${CMAKE_CURRENT_SOURCE_DIR}/include/*.h"
 )
 
-target_link_libraries(power_grid_model_c
-  PRIVATE power_grid_model
-)
+target_link_libraries(power_grid_model_c PRIVATE power_grid_model)
 
-target_sources(power_grid_model_c PUBLIC 
-  FILE_SET pgm_c_public_headers 
-  TYPE HEADERS 
-  BASE_DIRS "${CMAKE_CURRENT_SOURCE_DIR}/include/" 
-  FILES "${pgm_c_public_headers}"
-  )
+target_sources(
+    power_grid_model_c
+    PUBLIC
+        FILE_SET pgm_c_public_headers
+            TYPE HEADERS
+            BASE_DIRS "${CMAKE_CURRENT_SOURCE_DIR}/include/"
+            FILES "${pgm_c_public_headers}"
+)
 
-set_target_properties(power_grid_model_c PROPERTIES
-  VERSION ${PGM_VERSION}
-  SOVERSION ${PGM_VERSION}
-  INTERPROCEDURAL_OPTIMIZATION_RELEASE TRUE
-  INTERPROCEDURAL_OPTIMIZATION_RELWITHDEBINFO TRUE
+set_target_properties(
+    power_grid_model_c
+    PROPERTIES
+        VERSION ${PGM_VERSION}
+        SOVERSION ${PGM_VERSION}
+        INTERPROCEDURAL_OPTIMIZATION_RELEASE TRUE
+        INTERPROCEDURAL_OPTIMIZATION_RELWITHDEBINFO TRUE
 )
 
-install(TARGETS power_grid_model_c
-  EXPORT power_grid_modelTargets
-  COMPONENT power_grid_model
-  FILE_SET pgm_c_public_headers
+install(
+    TARGETS power_grid_model_c
+    EXPORT power_grid_modelTargets
+    COMPONENT power_grid_model
+    FILE_SET pgm_c_public_headers
 )

power_grid_model_c/power_grid_model_cpp/CMakeLists.txt

@@ -5,37 +5,37 @@
 # C++ wrapper library around C API
 add_library(power_grid_model_cpp INTERFACE)
 
-target_include_directories(power_grid_model_cpp INTERFACE
-  $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
-  $<INSTALL_INTERFACE:include>
+target_include_directories(
+    power_grid_model_cpp
+    INTERFACE
+        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+        $<INSTALL_INTERFACE:include>
 )
 
 file(
-  GLOB_RECURSE
-  pgm_cpp_public_headers
-  "${CMAKE_CURRENT_SOURCE_DIR}/include/*.hpp"
+    GLOB_RECURSE pgm_cpp_public_headers
+    "${CMAKE_CURRENT_SOURCE_DIR}/include/*.hpp"
 )
 
-target_link_libraries(power_grid_model_cpp
-	INTERFACE power_grid_model_c
-)
+target_link_libraries(power_grid_model_cpp INTERFACE power_grid_model_c)
 
-target_sources(power_grid_model_cpp PUBLIC 
-  FILE_SET pgm_cpp_public_headers 
-  TYPE HEADERS 
-  BASE_DIRS "${CMAKE_CURRENT_SOURCE_DIR}/include/" 
-  FILES "${pgm_cpp_public_headers}"
+target_sources(
+    power_grid_model_cpp
+    PUBLIC
+        FILE_SET pgm_cpp_public_headers
+            TYPE HEADERS
+            BASE_DIRS "${CMAKE_CURRENT_SOURCE_DIR}/include/"
+            FILES "${pgm_cpp_public_headers}"
 )
 
-set_target_properties(power_grid_model_cpp PROPERTIES
-  VERSION ${PGM_VERSION}
-  SOVERSION ${PGM_VERSION}
-  CXX_STANDARD 17
+set_target_properties(
+    power_grid_model_cpp
+    PROPERTIES VERSION ${PGM_VERSION} SOVERSION ${PGM_VERSION} CXX_STANDARD 17
 )
 
-
-install(TARGETS power_grid_model_cpp
-  EXPORT power_grid_modelTargets
-  COMPONENT power_grid_model
-  FILE_SET pgm_cpp_public_headers
+install(
+    TARGETS power_grid_model_cpp
+    EXPORT power_grid_modelTargets
+    COMPONENT power_grid_model
+    FILE_SET pgm_cpp_public_headers
 )