Add cmake-formatting-check to CI

The literal-comment-pattern arg is to disable comment reformatting

Author: Nopey

.cmake-format.py

@@ -0,0 +1,16 @@
+# A python-style configuration file for cmake-format
+# See their documentation for more information:
+# https://cmake-format.readthedocs.io/en/latest/configuration.html
+#
+# For info on how to run cmake-format, see CONTRIBUTING.md
+
+# ------------------------------------------------
+# Options affecting comment reflow and formatting.
+# ------------------------------------------------
+with section("markup"):
+
+  # If comment markup is enabled, don't reflow any comment block which matches
+  # this (regex) pattern. Default is `None` (disabled).
+  #
+  # An empty regex is used to match all comments, and disable comment reflow
+  literal_comment_pattern = ''

.github/workflows/compilation.yml

@@ -32,6 +32,21 @@ jobs:
       run: |
         fdfind . -e .c -e .h -X clang-format-${{ env.clang-format-version }} --dry-run --Werror
 
+  cmake-formatting-check:
+    name: CMake Formatting Check
+    runs-on: ubuntu-24.04
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install cmake-format and fd-find
+      run: |
+        sudo apt-get update
+        sudo apt-get -y install cmake-format fd-find
+    - name: Check cmake-format
+      run: |
+        fdfind . -e cmake . -X cmake-format '{}' --in-place --config-files .cmake-format.py
+        fdfind CMakeLists.txt . -X cmake-format '{}' --in-place --config-files .cmake-format.py
+        git --no-pager diff --exit-code
+
   # Run unittests on modern-ish versions of gcc and clang.
   # -----------------------------------------------------------------------------------------------
   unittest:
@@ -75,7 +90,7 @@ jobs:
   # Build windows package, release artifact (MSVC)
   # -----------------------------------------------------------------------------------------------
   build_msvc:
-    needs: [unittest, formatting-check]
+    needs: [unittest, formatting-check, cmake-formatting-check]
 
     name: Build windows-amd64 (MSVC)
     runs-on: windows-latest
@@ -157,7 +172,7 @@ jobs:
   # Build ubuntu package, release artifact
   # -----------------------------------------------------------------------------------------------
   build_ubuntu:
-    needs: [unittest, formatting-check]
+    needs: [unittest, formatting-check, cmake-formatting-check]
 
     name: Build ubuntu-latest
     runs-on: ubuntu-latest
@@ -237,7 +252,7 @@ jobs:
   # Build macos package, release artifact
   # -----------------------------------------------------------------------------------------------
   build_macos-arm:
-    needs: [unittest, formatting-check]
+    needs: [unittest, formatting-check, cmake-formatting-check]
 
     name: Build macos-14
     runs-on: macos-14
@@ -297,7 +312,7 @@ jobs:
   # Build windows package, release artifact (mingw-w64)
   # -----------------------------------------------------------------------------------------------
   build_windows:
-    needs: [unittest, formatting-check]
+    needs: [unittest, formatting-check, cmake-formatting-check]
 
     name: Build windows-amd64 (mingw-w64)
     runs-on: ubuntu-latest

CONTRIBUTING.md

@@ -40,6 +40,7 @@ Before making a pull request, please verify via a normal issue ticket
 Pull requests:
 * must not have any build errors
 * must be formatted using clang-format
+* must be formatted using cmake-format, when changing the build scripts
 * must be verified using clang-tidy
 
 ### PR workflow if you don't have merge rights
@@ -68,3 +69,19 @@ Pull requests:
 Note that we only give merge rights if you have been involved for a while
 and we feel you can be trusted. Therefore we also trust you to know how to do
 this and when to bend the rules and when not to.
+
+### Running cmake-format
+cmake-format may be available in your system package manager, or can be installed from pip:
+```
+pip install cmakelang
+```
+
+cmake-format can then be run like so, taking care to pass it the config-file argument:
+
+```sh
+# Format the main CMakeLists.txt file, making changes in-place
+cmake-format --in-place CMakeLists.txt --config-file .cmake-format.py
+
+# Format the cmake-scripts folder, making changes in-place
+cmake-format --in-place cmake-scripts/*.cmake --config-file .cmake-format.py
+```