Add corrections for cmake-format version and documentation

Author: szadam

CMakeLists.txt

@@ -217,24 +217,38 @@ if(UMF_FORMAT_CODE_STYLE)
     find_program(CLANG_FORMAT NAMES clang-format-15 clang-format-15.0 clang-format)
     find_program(CMAKE_FORMAT NAMES cmake-format)
 
-    if(CLANG_FORMAT AND CMAKE_FORMAT)
+    if(CLANG_FORMAT)
         get_program_version_major_minor(${CLANG_FORMAT} CLANG_FORMAT_VERSION)
-        get_program_version_major_minor(${CMAKE_FORMAT} CMAKE_FORMAT_VERSION)
         message(STATUS "Found clang-format: ${CLANG_FORMAT} "
-                "(version: ${CLANG_FORMAT_VERSION})")
-        message(STATUS "Found cmake-format: ${CMAKE_FORMAT} "
-                "(version: ${CMAKE_FORMAT_VERSION})")
+                       "(version: ${CLANG_FORMAT_VERSION})")
 
         # Check if clang-format (in correct version) is available for code formatting.
         set(CLANG_FORMAT_REQUIRED "15.0")
         if(NOT (CLANG_FORMAT_VERSION VERSION_EQUAL CLANG_FORMAT_REQUIRED))
             message(FATAL_ERROR "Required clang-format version is "
                     "${CLANG_FORMAT_REQUIRED}")
         endif()
-    else()
-        message(FATAL_ERROR "UMF_FORMAT_CODE_STYLE=ON, but clang-format or "
-                "cmake-format not found (required version: "
-                "${CLANG_FORMAT_REQUIRED})")
+    endif()
+
+    if(CMAKE_FORMAT)
+        get_program_version_major_minor(${CMAKE_FORMAT} CMAKE_FORMAT_VERSION)
+        message(STATUS "Found cmake-format: ${CMAKE_FORMAT} "
+                       "(version: ${CMAKE_FORMAT_VERSION})")
+
+        # Check if cmake-format (in correct version) is available for code
+        # formatting.
+        set(CMAKE_FORMAT_REQUIRED "0.6")
+        if(NOT (CMAKE_FORMAT_VERSION VERSION_EQUAL CMAKE_FORMAT_REQUIRED))
+            message(FATAL_ERROR "Required cmake-format version is"
+                                "${CMAKE_FORMAT_REQUIRED}")
+        endif()
+    endif()
+
+    if(NOT CLANG_FORMAT AND NOT CMAKE_FORMAT)
+        message(
+            FATAL_ERROR
+                "UMF_FORMAT_CODE_STYLE=ON, but neither clang-format (required version: "
+                "${CLANG_FORMAT_REQUIRED}) nor cmake-format was found.")
     endif()
 
     # Obtain files for clang-format check
@@ -283,6 +297,12 @@ if(UMF_FORMAT_CODE_STYLE)
     file(GLOB_RECURSE format_cmake_list ${format_cmake_glob})
     list(APPEND format_cmake_list "${PROJECT_SOURCE_DIR}/CMakeLists.txt")
 
+    # Print the list of files targeted for formatting by cmake-format
+    message(STATUS "Files to be formatted with cmake-format:")
+    foreach(file IN LISTS format_cmake_list)
+        message(STATUS "${file}")
+    endforeach()
+
     message(STATUS "Adding cmake-format-check and cmake-format-apply make "
             "targets")
 
@@ -295,6 +315,24 @@ if(UMF_FORMAT_CODE_STYLE)
         cmake-format-apply
         COMMAND ${CMAKE_FORMAT} --in-place ${format_cmake_list}
         COMMENT "Format files using cmake-format")
+
+    # Add a convenience target for running both clang-format and cmake-format
+    # checks/apply
+    add_custom_target(
+        format-checks
+        COMMAND ${CMAKE_COMMAND} --build ${CMAKE_BINARY_DIR} --target
+                clang-format-check
+        COMMAND ${CMAKE_COMMAND} --build ${CMAKE_BINARY_DIR} --target
+                cmake-format-check
+        COMMENT "Running both clang-format-check and cmake-format-check")
+
+    add_custom_target(
+        format-apply
+        COMMAND ${CMAKE_COMMAND} --build ${CMAKE_BINARY_DIR} --target
+                clang-format-apply
+        COMMAND ${CMAKE_COMMAND} --build ${CMAKE_BINARY_DIR} --target
+                cmake-format-apply
+        COMMENT "Format files using clang-format and cmake-format")
 endif()
 
 # Add license to the installation path

CONTRIBUTING.md

@@ -74,23 +74,28 @@ To verify correct coding style of your changes execute (assuming `build` is your
 
 ```bash
 $ cmake -B build -DUMF_FORMAT_CODE_STYLE=ON
-$ cmake --build build --target clang-format-check
-$ cmake --build build --target cmake-format-check
+$ cmake --build build --target format-checks
 ```
 
-We run this check in our Continuous Integration (CI). So, if any issues were found,
+We run these checks in our Continuous Integration (CI). So, if any issues were found,
 the Pull Request will be blocked from merging. To apply proper formatting (meaning,
-to fix the issues) execute the second available CMake target - run a command:
+to fix the issues) you can use the convenience target provided for applying formats:
 
 ```bash
-$ cmake --build build --target clang-format-apply
-$ cmake --build build --target cmake-format-apply
+$ cmake --build build --target format-apply
 
 # Remember to review introduced changes
 ```
 
-**NOTE**: We use specific clang-format version - **15.0** is required. It can be installed,
-e.g., with command: `python -m pip install clang-format==15.0.7`.
+If you wish to use only `clang-format` or only `cmake-format`, you can execute the corresponding
+`clang-format-check` and `clang-format-apply` for source files, or `cmake-format-check` and
+`cmake-format-apply` for CMake files, respectively.
+
+**NOTE**: We use specific versions of formatting tools to ensure consistency across the project. The required versions are:
+- clang-format version **15.0**, which can be installed with the command: `python -m pip install clang-format==15.0.7`.
+- cmake-format version **0.6.13**, which can be installed with the command: `python -m pip install cmake-format==0.6`.
+
+Please ensure you have these specific versions installed before contributing to the project.
 
 ### When my PR is merged?
 

README.md

@@ -30,7 +30,7 @@ Required packages:
 
 For development and contributions:
 - clang-format-15.0 (can be installed with `python -m pip install clang-format==15.0.7`)
-- cmake-format (can be installed with `python -m pip install cmake-format`)
+- cmake-format-0.6 (can be installed with `python -m pip install cmake-format==0.6.13`)
 
 For building tests, multithreaded benchmarks and Disjoint Pool:
 - C++ compiler with C++17 support

third_party/requirements.txt

@@ -1,7 +1,7 @@
 # Python requirements modules
 # Formatting the source code
 clang-format==15.0.7
-cmake-format==0.6
+cmake-format==0.6.13
 # Generating HTML documentation
 pygments==2.5.2
 sphinxcontrib_applehelp==1.0.4