Add clang-tidy and clang-format tools + update CI workflows

Author: ramsafin

.github/workflows/clang-format.yml

@@ -26,9 +26,10 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Install clang-format
-        run: sudo apt update && sudo apt install -y clang-format
+        run: sudo apt update && sudo apt install -y clang-format cmake ninja-build g++ gcc
 
-      - name: Run clang-format check
-        run: |
-          FILES=$(find . \( -name '*.cpp' -o -name '*.hpp' \) -not -path "./build/*")
-          clang-format --dry-run --Werror $FILES
+      - name: Configure project
+        run: cmake --preset gcc-RelWithDebInfo
+
+      - name: Run clang-format
+        run: cmake --build build/gcc-RelWithDebInfo/ --target clang-format

.github/workflows/clang-tidy.yml

@@ -36,5 +36,4 @@ jobs:
         run: cmake --preset gcc-RelWithDebInfo
 
       - name: Run clang-tidy
-        run: |
-          find src include tests -name '*.cpp' | xargs clang-tidy -p build/gcc-RelWithDebInfo
+        run: cmake --build build/gcc-RelWithDebInfo/ --target clang-tidy

CMakeLists.txt

@@ -53,3 +53,9 @@ include(tools/Doxygen)
 
 # === Installation ===
 include(install/InstallConfig)
+
+# === Formatting ===
+include(tools/ClangFormat)
+
+# === Linting ===
+include(tools/ClangTidy)

cmake/tools/ClangFormat.cmake

@@ -0,0 +1,25 @@
+find_program(CLANG_FORMAT_EXE NAMES clang-format)
+
+if(CLANG_FORMAT_EXE)
+
+  # Collect all relevant source/header files recursively
+  file(GLOB_RECURSE ALL_SOURCE_FILES
+    "${CMAKE_SOURCE_DIR}/src/*.cpp"
+    "${CMAKE_SOURCE_DIR}/src/**/*.cpp"
+    "${CMAKE_SOURCE_DIR}/include/*.hpp"
+    "${CMAKE_SOURCE_DIR}/include/**/*.hpp"
+    "${CMAKE_SOURCE_DIR}/tests/*.cpp"
+    "${CMAKE_SOURCE_DIR}/tests/**/*.cpp"
+    "${CMAKE_SOURCE_DIR}/tests/*.hpp"
+    "${CMAKE_SOURCE_DIR}/tests/**/*.hpp"
+  )
+
+  add_custom_target(clang-format
+    COMMAND ${CLANG_FORMAT_EXE} --dry-run --Werror ${ALL_SOURCE_FILES}
+    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+    COMMENT "🔍 Checking format (clang-format --dry-run --Werror)"
+    VERBATIM
+  )
+else()
+  message(STATUS "⚠️\tclang-format not found — 'clang-format' target will not be available.")
+endif()

cmake/tools/ClangTidy.cmake

@@ -0,0 +1,19 @@
+find_program(CLANG_TIDY_EXE NAMES clang-tidy)
+
+if(CLANG_TIDY_EXE)
+  file(GLOB_RECURSE TIDY_SOURCE_FILES
+    "${CMAKE_SOURCE_DIR}/src/*.cpp"
+    "${CMAKE_SOURCE_DIR}/src/**/*.cpp"
+    "${CMAKE_SOURCE_DIR}/tests/*.cpp"
+    "${CMAKE_SOURCE_DIR}/tests/**/*.cpp"
+  )
+
+  add_custom_target(clang-tidy
+    COMMAND ${CLANG_TIDY_EXE} ${TIDY_SOURCE_FILES} --quiet -p ${CMAKE_BINARY_DIR}
+    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+    COMMENT "🔍 Running clang-tidy analysis"
+    VERBATIM
+  )
+else()
+  message(STATUS "⚠️ clang-tidy not found — 'clang-tidy' target will not be available.")
+endif()

include/math/arithmetic.hpp

@@ -12,20 +12,20 @@ namespace math
 /**
  * @brief Adds two integers.
  *
- * @param a First integer.
- * @param b Second integer.
- * @return Sum of a and b.
+ * @param left First integer.
+ * @param right Second integer.
+ * @return Sum of left and right.
  */
-int add(int a, int b);
+int add(int left, int right);
 
 /**
  * @brief Subtracts two integers.
  *
- * @param a First integer.
- * @param b Second integer.
- * @return Difference of a and b.
+ * @param left First integer.
+ * @param right Second integer.
+ * @return Difference of left and right.
  */
-int subtract(int a, int b);
+int subtract(int left, int right);
 
 }  // namespace math
 

src/arithmetic.cpp

@@ -3,14 +3,14 @@
 namespace math
 {
 
-int add(int a, int b)
+int add(int left, int right)
 {
-  return a + b;
+  return left + right;
 }
 
-int subtract(int a, int b)
+int subtract(int left, int right)
 {
-  return a - b;
+  return left - right;
 }
 
 }  // namespace math

src/main.cpp

@@ -4,11 +4,11 @@
 
 int main()
 {
-  const int a = 10;
-  const int b = 4;
+  const int left = 10;
+  const int right = 4;
 
-  std::cout << "Add: " << math::add(a, b) << '\n';
-  std::cout << "Subtract: " << math::subtract(a, b) << '\n';
+  std::cout << "Add: " << math::add(left, right) << '\n';
+  std::cout << "Subtract: " << math::subtract(left, right) << '\n';
 
   return 0;
 }