add gersemi to pre-commit hooks for CMake formatting like black

enetheru · enetheru · commit 774477257065 · 2025-03-01T11:42:23.000+10:30
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -33,6 +33,12 @@ repos:
       - id: codespell
         additional_dependencies: [tomli]
 
+  - repo: https://github.com/BlankSpruce/gersemi
+    rev: 0.18.2
+    hooks:
+      - id: gersemi
+        args: ["-i", "--no-warn-about-unknown-commands", "-l", "120"]
+
   - repo: local
     hooks:
       - id: copyright-headers
diff --git a/cmake/GodotCPPModule.cmake b/cmake/GodotCPPModule.cmake
@@ -137,6 +137,7 @@ function( generate_doc_source OUTPUT_PATH SOURCES )
             VERBATIM
             WORKING_DIRECTORY "${godot-cpp_SOURCE_DIR}"
             DEPENDS
+        DEPENDS #
             "${godot-cpp_SOURCE_DIR}/doc_source_generator.py"
             "${SOURCES}"
             COMMENT "Generating: ${OUTPUT_PATH}"
diff --git a/cmake/common_compiler_flags.cmake b/cmake/common_compiler_flags.cmake
@@ -46,19 +46,14 @@ endfunction(  )
 
 function( common_compiler_flags )
 
-    target_compile_features(${TARGET_NAME}
-            PUBLIC
-            cxx_std_17
-    )
-
+    # gersemi: off
     # These compiler options reflect what is in godot/SConstruct.
-    target_compile_options( ${TARGET_NAME}
+    target_compile_options(
+        ${TARGET_NAME}
         PUBLIC
             # Disable exception handling. Godot doesn't use exceptions anywhere, and this
             # saves around 20% of binary size and very significant build time.
-            $<${DISABLE_EXCEPTIONS}:
-                $<${NOT_MSVC}:-fno-exceptions>
-            >
+            $<${DISABLE_EXCEPTIONS}:$<${NOT_MSVC}:-fno-exceptions>>
 
             # Enabling Debug Symbols
             $<${DEBUG_SYMBOLS}:
@@ -70,78 +65,75 @@ function( common_compiler_flags )
                 >
             >
 
-            $<${IS_DEV_BUILD}:
-                $<${NOT_MSVC}:-fno-omit-frame-pointer -O0>
+            $<${IS_DEV_BUILD}:$<${NOT_MSVC}:-fno-omit-frame-pointer -O0>>
+
+            $<${HOT_RELOAD}:$<${IS_GNU}:-fno-gnu-unique>>
+
+            # MSVC only
+            $<${IS_MSVC}:
+                # /MP isn't valid for clang-cl with msvc frontend
+                $<$<CXX_COMPILER_ID:MSVC>:/MP${PROC_N}>
+                /W4
+
+                # Disable warnings which we don't plan to fix.
+                /wd4100  # C4100 (unreferenced formal parameter): Doesn't play nice with polymorphism.
+                /wd4127  # C4127 (conditional expression is constant)
+                /wd4201  # C4201 (non-standard nameless struct/union): Only relevant for C89.
+                /wd4244  # C4244 C4245 C4267 (narrowing conversions): Unavoidable at this scale.
+                /wd4245
+                /wd4267
+                /wd4305  # C4305 (truncation): double to float or real_t, too hard to avoid.
+                /wd4514  # C4514 (unreferenced inline function has been removed)
+                /wd4714  # C4714 (function marked as __forceinline not inlined)
+                /wd4820  # C4820 (padding added after construct)
+
+                /utf-8
+            >
+
+            # Clang and GNU common options
+            $<$<OR:${IS_CLANG},${IS_GNU}>:
+                -Wall
+                -Wctor-dtor-privacy
+                -Wextra
+                -Wno-unused-parameter
+                -Wnon-virtual-dtor
+                -Wwrite-strings
             >
 
-            $<${HOT_RELOAD}:
-                $<${IS_GNU}:-fno-gnu-unique>
+            # Clang only
+            $<${IS_CLANG}:
+                -Wimplicit-fallthrough
+                -Wno-ordered-compare-function-pointers
             >
 
-        # MSVC only
-        $<${IS_MSVC}:
-            # /MP isn't valid for clang-cl with msvc frontend
-            $<$<CXX_COMPILER_ID:MSVC>:/MP${PROC_N}>
-            /W4
-
-            # Disable warnings which we don't plan to fix.
-            /wd4100  # C4100 (unreferenced formal parameter): Doesn't play nice with polymorphism.
-            /wd4127  # C4127 (conditional expression is constant)
-            /wd4201  # C4201 (non-standard nameless struct/union): Only relevant for C89.
-            /wd4244  # C4244 C4245 C4267 (narrowing conversions): Unavoidable at this scale.
-            /wd4245
-            /wd4267
-            /wd4305  # C4305 (truncation): double to float or real_t, too hard to avoid.
-            /wd4514  # C4514 (unreferenced inline function has been removed)
-            /wd4714  # C4714 (function marked as __forceinline not inlined)
-            /wd4820  # C4820 (padding added after construct)
-
-            /utf-8
-        >
-
-        # Clang and GNU common options
-        $<$<OR:${IS_CLANG},${IS_GNU}>:
-            -Wall
-            -Wctor-dtor-privacy
-            -Wextra
-            -Wno-unused-parameter
-            -Wnon-virtual-dtor
-            -Wwrite-strings
-        >
-
-        # Clang only
-        $<${IS_CLANG}:
-            -Wimplicit-fallthrough
-            -Wno-ordered-compare-function-pointers
-        >
-
-        # GNU only
-        $<${IS_GNU}:
-            -Walloc-zero
-            -Wduplicated-branches
-            -Wduplicated-cond
-            -Wno-misleading-indentation
-            -Wplacement-new=1
-            -Wshadow-local
-            -Wstringop-overflow=4
-
-            # Bogus warning fixed in 8+.
-            $<${GNU_LT_V8}:-Wno-strict-overflow>
-
-            $<${GNU_GE_V9}:-Wattribute-alias=2>
-
-            # Broke on MethodBind templates before GCC 11.
-            $<${GNU_GT_V11}:-Wlogical-op>
-
-            # Regression in GCC 9/10, spams so much in our variadic templates that we need to outright disable it.
-            $<${GNU_LT_V11}:-Wno-type-limits>
-
-            # False positives in our error macros, see GH-58747.
-            $<${GNU_GE_V12}:-Wno-return-type>
-        >
+            # GNU only
+            $<${IS_GNU}:
+                -Walloc-zero
+                -Wduplicated-branches
+                -Wduplicated-cond
+                -Wno-misleading-indentation
+                -Wplacement-new=1
+                -Wshadow-local
+                -Wstringop-overflow=4
+
+                # Bogus warning fixed in 8+.
+                $<${GNU_LT_V8}:-Wno-strict-overflow>
+
+                $<${GNU_GE_V9}:-Wattribute-alias=2>
+
+                # Broke on MethodBind templates before GCC 11.
+                $<${GNU_GT_V11}:-Wlogical-op>
+
+                # Regression in GCC 9/10, spams so much in our variadic templates that we need to outright disable it.
+                $<${GNU_LT_V11}:-Wno-type-limits>
+
+                # False positives in our error macros, see GH-58747.
+                $<${GNU_GE_V12}:-Wno-return-type>
+            >
     )
 
-    target_compile_definitions(${TARGET_NAME}
+    target_compile_definitions(
+        ${TARGET_NAME}
         PUBLIC
             GDEXTENSION
 
@@ -159,19 +151,21 @@ function( common_compiler_flags )
             $<${THREADS_ENABLED}:THREADS_ENABLED>
     )
 
-    target_link_options( ${TARGET_NAME}
+    target_link_options(
+        ${TARGET_NAME}
         PUBLIC
             $<${IS_MSVC}:
                 /WX             # treat link warnings as errors.
                 /MANIFEST:NO    # We dont need a manifest
             >
 
             $<${DEBUG_SYMBOLS}:$<${IS_MSVC}:/DEBUG:FULL>>
+
             $<$<NOT:${DEBUG_SYMBOLS}>:
                 $<${IS_GNU}:-s>
                 $<${IS_CLANG}:-s>
                 $<${IS_APPLECLANG}:-Wl,-S -Wl,-x -Wl,-dead_strip>
             >
     )
-
+    # gersemi: on
 endfunction()
diff --git a/cmake/godotcpp.cmake b/cmake/godotcpp.cmake
@@ -324,8 +324,10 @@ function( godotcpp_generate )
                 ${GODOTCPP_GDEXTENSION_DIR}
         )
 
-        set_target_properties( ${TARGET_NAME}
-                PROPERTIES
+        # gersemi: off
+        set_target_properties(
+            ${TARGET_NAME}
+            PROPERTIES
                 CXX_STANDARD 17
                 CXX_EXTENSIONS OFF
                 CXX_VISIBILITY_PRESET ${GODOTCPP_SYMBOL_VISIBILITY}
@@ -349,6 +351,7 @@ function( godotcpp_generate )
                 # Some IDE's respect this property to logically group targets
                 FOLDER "godot-cpp"
         )
+        # gersemi: on
 
         if( CMAKE_SYSTEM_NAME STREQUAL Android )
             android_generate()
diff --git a/cmake/web.cmake b/cmake/web.cmake
@@ -14,24 +14,26 @@ function( web_options )
     # web options
 endfunction()
 
-
-function( web_generate )
-    target_compile_definitions(${TARGET_NAME}
-            PUBLIC
+function(web_generate)
+    target_compile_definitions(
+        ${TARGET_NAME}
+        PUBLIC #
             WEB_ENABLED
             UNIX_ENABLED
     )
 
-    target_compile_options( ${TARGET_NAME}
-            PUBLIC
+    target_compile_options(
+        ${TARGET_NAME}
+        PUBLIC #
             -sSIDE_MODULE
             -sSUPPORT_LONGJMP=wasm
             -fno-exceptions
             $<${THREADS_ENABLED}:-sUSE_PTHREADS=1>
     )
 
-    target_link_options( ${TARGET_NAME}
-            INTERFACE
+    target_link_options(
+        ${TARGET_NAME}
+        INTERFACE #
             -sWASM_BIGINT
             -sSUPPORT_LONGJMP=wasm
             -fvisibility=hidden
diff --git a/cmake/windows.cmake b/cmake/windows.cmake
@@ -84,9 +84,10 @@ function( windows_generate )
             >
     )
 
-    target_link_options( ${TARGET_NAME}
-            PUBLIC
-
+    # gersemi: off
+    target_link_options(
+        ${TARGET_NAME}
+        PUBLIC
             $<${NOT_MSVC}:
                 -Wl,--no-undefined
                 $<${STATIC_CPP}:
@@ -98,6 +99,7 @@ function( windows_generate )
 
             $<${IS_CLANG}:-lstdc++>
     )
+    # gersemi: on
 
     common_compiler_flags()
 endfunction()
diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
@@ -42,8 +42,10 @@ foreach( TARGET_ALIAS template_debug template_release editor )
     get_target_property( GODOTCPP_SUFFIX   ${LINK_TARGET} GODOTCPP_SUFFIX      )
     get_target_property( OSX_ARCH       ${LINK_TARGET} OSX_ARCHITECTURES )
 
-    set_target_properties( ${TARGET_NAME}
-            PROPERTIES
+    # gersemi: off
+    set_target_properties(
+        ${TARGET_NAME}
+        PROPERTIES
             CXX_STANDARD 17
             CXX_EXTENSIONS OFF
             CXX_VISIBILITY_PRESET ${GODOTCPP_SYMBOL_VISIBILITY}
@@ -67,6 +69,7 @@ foreach( TARGET_ALIAS template_debug template_release editor )
             # Some IDE's respect this property to logically group targets
             FOLDER "godot-cpp"
     )
+    # gersemi: on
 
     # CMAKE_SYSTEM_NAME refers to the target system
     if( CMAKE_SYSTEM_NAME STREQUAL Darwin )

Original file line number	Diff line number	Diff line change
`@@ -84,9 +84,10 @@ function( windows_generate )`
`84`	`84`	`>`
`85`	`85`	`)`
`86`	`86`
`87`		`- target_link_options( ${TARGET_NAME}`
`88`		`- PUBLIC`
`89`		`-`
	`87`	`+ # gersemi: off`
	`88`	`+ target_link_options(`
	`89`	`+ ${TARGET_NAME}`
	`90`	`+ PUBLIC`
`90`	`91`	`$<${NOT_MSVC}:`
`91`	`92`	`-Wl,--no-undefined`
`92`	`93`	`$<${STATIC_CPP}:`
`@@ -98,6 +99,7 @@ function( windows_generate )`
`98`	`99`
`99`	`100`	`$<${IS_CLANG}:-lstdc++>`
`100`	`101`	`)`
	`102`	`+ # gersemi: on`
`101`	`103`
`102`	`104`	`common_compiler_flags()`
`103`	`105`	`endfunction()`