Feature/cwm/4 add clang format and clang tidy configuration (#9)

* Add scripts and checks

* Run clang-format

* Fixing linter errors

* Fix linting errors, don't analyze  hpp files

* Pin clang-format version

* Check version of clang-format

* Fix script

Author: codingwithmagga

.clang-format

@@ -0,0 +1,9 @@
+BasedOnStyle: Google
+ColumnLimit: 160
+IndentWidth: 4
+AccessModifierOffset: -4
+BreakBeforeBraces: Allman
+SortIncludes: true
+AllowShortFunctionsOnASingleLine: Empty
+DerivePointerAlignment: false
+PointerAlignment: Left

.clang-tidy

@@ -0,0 +1,11 @@
+Checks: >
+  bugprone-*,
+  modernize-*,
+  performance-*,
+  readability-*,
+  cppcoreguidelines-*,
+  misc-*,
+  -modernize-use-trailing-return-type,
+  -readability-magic-numbers,
+  -cppcoreguidelines-avoid-magic-numbers
+WarningsAsErrors: '*'

.github/workflows/ci.yml

@@ -71,12 +71,35 @@ jobs:
         run: ./build/cpuscope_cli --version
 
   lint:
-    name: Lint (Placeholder)
+    name: Lint
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Placeholder lint
-        run: echo "Lint checks will be added later"
+
+      - name: Install lint dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y cmake ninja-build ccache clang-format-18 clang-tidy clang-17
+      
+      - name: Check clang-format version
+        run: clang-format --version
+
+      - name: Configure compile commands
+        run: |
+          mkdir -p build
+          cmake -S . -B build -G Ninja \
+            -DCMAKE_EXPORT_COMPILE_COMMANDS=ON \
+            -DCPUSCOPE_BUILD_TESTS=ON \
+            -DCMAKE_C_COMPILER=clang-17 \
+            -DCMAKE_CXX_COMPILER=clang++-17 \
+            -DCMAKE_C_COMPILER_LAUNCHER=ccache \
+            -DCMAKE_CXX_COMPILER_LAUNCHER=ccache
+
+      - name: Check formatting
+        run: scripts/check-format.sh
+
+      - name: Run static analysis
+        run: scripts/lint.sh
 
   sanitizer:
     name: Sanitizer Build

CMakeLists.txt

@@ -2,6 +2,8 @@ cmake_minimum_required(VERSION 3.25)
 
 project(cpuscope VERSION 0.1.0 LANGUAGES C CXX)
 
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
 if(${CMAKE_SOURCE_DIR} STREQUAL ${CMAKE_BINARY_DIR})
   message(FATAL_ERROR "In-source builds are not allowed. Please use a separate build directory.")
 endif()

cli/main.cpp

@@ -1,16 +1,19 @@
 #include <iostream>
-#include <vector>
+#include <span>
 #include <string_view>
+#include <vector>
 
 #include "cpuscope_lib.hpp"
 
-int main(int argc, char *argv[])
+int main(int argc, char* argv[])
 {
     std::vector<std::string_view> args;
     args.reserve(argc);
-    for (int i = 0; i < argc; ++i)
+
+    const std::span<char*> arguments(argv, argc);
+    for (char* arg : arguments)
     {
-        args.emplace_back(argv[i]);
+        args.emplace_back(arg);
     }
 
     std::cout << cpuscope::format_message(args) << '\n';

lib/include/cpuscope_lib.hpp

@@ -4,14 +4,13 @@
 #include <span>
 #include <string>
 #include <string_view>
-#include <vector>
 
 namespace cpuscope
 {
 
-    inline std::string format_message(std::span<const std::string_view> args)
-    {
-        return std::format("CPUScope CLI placeholder: {} arguments received.", args.size());
-    }
+inline std::string format_message(std::span<const std::string_view> args)
+{
+    return std::format("CPUScope CLI placeholder: {} arguments received.", args.size());
+}
 
-} // namespace cpuscope
+}  // namespace cpuscope

lib/include/version.hpp

@@ -5,9 +5,9 @@
 namespace cpuscope
 {
 
-    std::string get_version()
-    {
-        return "0.1.0";
-    }
+inline std::string get_version()
+{
+    return "0.1.0";
+}
 
-} // namespace cpuscope
+}  // namespace cpuscope

lib/src/cpuscope_lib.cpp

@@ -1,8 +1,10 @@
-#include "cpuscope_lib.hpp"
+// Linter error: Will be resolved once the library has more functionality and is no longer a
+// placeholder.
+// #include "cpuscope_lib.hpp"
 
 namespace cpuscope
 {
 
-    // Implementation is header-only for the initial placeholder functionality.
+// Implementation is header-only for the initial placeholder functionality.
 
-} // namespace cpuscope
+}  // namespace cpuscope

scripts/check-format.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+set -e
+
+FAILED=0
+
+while IFS= read -r -d '' file; do
+  if ! diff -u "$file" <(clang-format "$file"); then
+    FAILED=1
+  fi
+done < <(
+  find . \
+    \( -path ./build -o -path ./build-\* -o -path ./.git -o -path ./scripts \) -prune \
+    -o \( -name "*.cpp" -o -name "*.hpp" \) -print0
+)
+
+if [ "$FAILED" -ne 0 ]; then
+  echo "Formatting issues detected."
+  exit 1
+fi

scripts/format.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+find . \( -name "*.cpp" -o -name "*.hpp" \) -exec clang-format -i {} +