Major refactor

Author: ramsafin

.clang-tidy

@@ -10,11 +10,17 @@ Checks: >
   -cppcoreguidelines-owning-memory
 
 UseColor: true
-WarningsAsErrors: ''
+WarningsAsErrors: '*'
 HeaderFilterRegex: '^(include|src|tests|benchmarks)/'
 FormatStyle: file
 CheckOptions:
   - key: modernize-use-nullptr.NullMacros
     value: 'NULL'
   - key: readability-identifier-naming.VariableCase
     value: camelBack
+  - key: readability-identifier-naming.ClassCase
+    value: CamelCase
+  - key: readability-identifier-naming.ConstantCase
+    value: UPPER_CASE
+  - key: readability-identifier-naming.ParameterCase
+    value: camelBack

.github/workflows/ci.yml

@@ -28,7 +28,7 @@ jobs:
       matrix:
         os: [ubuntu-latest]
         compiler: [gcc, clang]
-        build_type: [RelWithDebInfo, Sanitize]
+        build_type: [RelWithDebInfo]
 
     steps:
       - name: Checkout code
@@ -55,4 +55,4 @@ jobs:
         run: cmake --build --preset ${{ matrix.compiler }}-${{ matrix.build_type }}
 
       - name: Run tests
-        run: ctest --preset ${{ matrix.compiler }}-${{ matrix.build_type }} --output-on-failure
+        run: ctest --preset ${{ matrix.compiler }}-${{ matrix.build_type }}

.github/workflows/clang-format.yml

@@ -32,4 +32,4 @@ jobs:
         run: cmake --preset gcc-RelWithDebInfo
 
       - name: Run clang-format
-        run: cmake --build build/gcc-RelWithDebInfo/ --target clang-format
+        run: cmake --build --preset gcc-RelWithDebInfo --target clang-format-check

.github/workflows/clang-tidy.yml

@@ -36,4 +36,4 @@ jobs:
         run: cmake --preset gcc-RelWithDebInfo
 
       - name: Run clang-tidy
-        run: cmake --build build/gcc-RelWithDebInfo/ --target clang-tidy
+        run: cmake --build --preset gcc-RelWithDebInfo --target clang-tidy

.vscode/settings.json

@@ -2,10 +2,11 @@
   "C_Cpp.autoAddFileAssociations": false,
   // Use CMake presets instead of manual configuration
   "cmake.useCMakePresets": "always",
+  "cmake.configureOnOpen": false,
+  "cmake.autoReload": false,
   "cmake.configurePreset": "gcc-RelWithDebInfo",
   "cmake.buildPreset": "gcc-RelWithDebInfo",
   "cmake.testPreset": "gcc-RelWithDebInfo",
-  "cmake.autoReload": false,
   // Disable Microsoft IntelliSense (we use clangd)
   "C_Cpp.intelliSenseEngine": "disabled",
   "C_Cpp.enabled": false,
@@ -30,4 +31,4 @@
     "editor.defaultFormatter": "llvm-vs-code-extensions.vscode-clangd",
     "editor.formatOnSave": true,
   }
-}
+}

CMakeLists.txt

@@ -1,75 +1,91 @@
 cmake_minimum_required(VERSION 3.23 FATAL_ERROR)
 project(modern_cpp_project LANGUAGES CXX VERSION 0.1.0)
 
-# Enable C++20 with strict enforcement
+# === C++ Standard ===
 set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
-# Export compile_commands.json for clangd and clang-tidy
+# === Compile Commands ===
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
-# Options
-option(ENABLE_TESTING    "Build tests" ON)
-option(ENABLE_BENCHMARKS "Build benchmarks" ON)
-option(BUILD_APP         "Build the demo application" ON)
-option(BUILD_DOCS        "Build documentation via Doxygen" ON)
-
-# Add custom "Sanitize" build type
+# === Custom Build Types ===
 if(CMAKE_CONFIGURATION_TYPES)
-  list(APPEND CMAKE_CONFIGURATION_TYPES Sanitize)
+  foreach(build_type IN ITEMS Sanitize Coverage)
+    list(APPEND CMAKE_CONFIGURATION_TYPES ${build_type})
+  endforeach()
   list(REMOVE_DUPLICATES CMAKE_CONFIGURATION_TYPES)
   set(CMAKE_CONFIGURATION_TYPES "${CMAKE_CONFIGURATION_TYPES}" CACHE STRING "" FORCE)
 endif()
 
-# Add custom "Coverage" build type
-if(CMAKE_CONFIGURATION_TYPES)
-  list(APPEND CMAKE_CONFIGURATION_TYPES Coverage)
-  list(REMOVE_DUPLICATES CMAKE_CONFIGURATION_TYPES)
-  set(CMAKE_CONFIGURATION_TYPES "${CMAKE_CONFIGURATION_TYPES}" CACHE STRING "" FORCE)
+# === Project Options ===
+option(ENABLE_WARNINGS          "Enable compiler warnings"          ON)
+option(ENABLE_STRICT_WARNINGS   "Treat warnings as errors"          ON)
+
+option(ENABLE_SANITIZERS        "Enable sanitizer instrumentation"  OFF)
+
+option(ENABLE_TESTING           "Build unit tests"                  ON)
+option(ENABLE_BENCHMARKS        "Build benchmarks"                  ON)
+option(ENABLE_COVERAGE          "Enable coverage instrumentation"   OFF)
+
+option(BUILD_APP                "Build the demo app"                ON)
+option(BUILD_DOCS               "Build Doxygen documentation"       ON)
+
+option(ENABLE_CPPCHECK          "Enable cppcheck analysis target"   ON)
+option(ENABLE_CLANG_TIDY        "Enable clang-tidy analysis target" ON)
+option(ENABLE_CLANG_FORMAT      "Enable clang-format target"        ON)
+
+# === Normalize Build Type (e.g., for string comparison) ===
+if(CMAKE_BUILD_TYPE)
+  string(TOLOWER "${CMAKE_BUILD_TYPE}" BUILD_TYPE_LOWER)
+else()
+  set(BUILD_TYPE_LOWER "release")
+endif()
+
+# === Auto-toggle Options for Special Build Types ===
+if(BUILD_TYPE_LOWER STREQUAL "sanitize")
+  set(ENABLE_SANITIZERS ON CACHE BOOL "Enable sanitizers" FORCE)
 endif()
 
-# Load cmake modules
+if(BUILD_TYPE_LOWER STREQUAL "coverage")
+  set(ENABLE_COVERAGE ON CACHE BOOL "Enable coverage" FORCE)
+  set(BUILD_APP OFF CACHE BOOL "Disable building app in coverage builds" FORCE)
+  set(ENABLE_BENCHMARKS OFF CACHE BOOL "Disable benchmarks in coverage builds" FORCE)
+endif()
+
+# === CMake Module Path ===
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
 
-# Warnings, Sanitizers, Link Time Optimization (LTO)
-include(options/LTO)
+# === Core Configuration ===
 include(options/Warnings)
 include(options/Sanitizers)
 
-# Coverage
+# === Optional Tooling ===
 include(tools/Coverage)
+include(tools/Cppcheck)
+include(tools/ClangTidy)
+include(tools/ClangFormat)
 
-# === Libraries ===
-add_subdirectory(src) # modern_cpp_project::math
+# === Core library ===
+add_subdirectory(src)  # modern_cpp_project::math
 
 # === Application ===
-if(BUILD_APP AND NOT CMAKE_BUILD_TYPE STREQUAL "Coverage")
-  add_subdirectory(app) # modern_cpp_project_app
+if(BUILD_APP)
+  add_subdirectory(app)  # modern_cpp_project_app
 endif()
 
-# === Tests ===
+# === Unit Tests ===
 if(ENABLE_TESTING)
   enable_testing()
   add_subdirectory(tests)
 endif()
 
+# === Benchmarks ===
 if(ENABLE_BENCHMARKS)
-  if (NOT CMAKE_BUILD_TYPE STREQUAL "Coverage" AND NOT CMAKE_BUILD_TYPE STREQUAL "Sanitize")
-    add_subdirectory(benchmarks)
-  endif()
+  add_subdirectory(benchmarks)
 endif()
 
-# === Docs ===
-if(BUILD_DOCS)
-  include(tools/Doxygen)
-endif()
+# === Documentation ===
+include(tools/Doxygen)
 
 # === Installation ===
 include(install/InstallConfig)
-
-# === Formatting ===
-include(tools/ClangFormat)
-
-# === Linting ===
-include(tools/ClangTidy)
-include(tools/Cppcheck)

CMakePresets.json

@@ -12,9 +12,11 @@
       "binaryDir": "${sourceDir}/build/${presetName}",
       "cacheVariables": {
         "ENABLE_TESTING": "ON",
-        "ENABLE_BENCHMARKS": "ON",
-        "BUILD_APP": "ON",
-        "BUILD_DOCS": "ON",
+        "ENABLE_BENCHMARKS": "OFF",
+        "BUILD_APP": "OFF",
+        "BUILD_DOCS": "OFF",
+        "ENABLE_WARNINGS": "ON",
+        "ENABLE_STRICT_WARNINGS": "ON",
         "CMAKE_EXPORT_COMPILE_COMMANDS": "ON"
       },
       "description": "Shared settings for all configurations"
@@ -68,8 +70,7 @@
       "inherits": "conf-base-gcc",
       "cacheVariables": {
         "CMAKE_BUILD_TYPE": "Sanitize",
-        "ENABLE_BENCHMARKS": "OFF",
-        "BUILD_APP": "OFF"
+        "ENABLE_SANITIZERS": "ON"
       },
       "description": "GCC build with sanitizers"
     },
@@ -78,8 +79,7 @@
       "inherits": "conf-base-gcc",
       "cacheVariables": {
         "CMAKE_BUILD_TYPE": "Coverage",
-        "ENABLE_BENCHMARKS": "OFF",
-        "BUILD_APP": "OFF"
+        "ENABLE_COVERAGE": "ON"
       },
       "description": "GCC build for coverage analysis"
     },
@@ -112,8 +112,7 @@
       "inherits": "conf-base-clang",
       "cacheVariables": {
         "CMAKE_BUILD_TYPE": "Sanitize",
-        "ENABLE_BENCHMARKS": "OFF",
-        "BUILD_APP": "OFF"
+        "ENABLE_SANITIZERS": "ON"
       },
       "description": "Clang build with sanitizers"
     },
@@ -122,8 +121,7 @@
       "inherits": "conf-base-clang",
       "cacheVariables": {
         "CMAKE_BUILD_TYPE": "Coverage",
-        "ENABLE_BENCHMARKS": "OFF",
-        "BUILD_APP": "OFF"
+        "ENABLE_COVERAGE": "ON"
       },
       "description": "Clang build for coverage analysis"
     }

README.md

@@ -14,7 +14,7 @@
 - ✅ CMake presets with Clang & GCC support
 - ✅ C++20 (extendable to C++23)
 - ✅ GoogleTest and Google Benchmarks (with `FetchContent`)
-- ✅ Sanitizers, Link Time Optimization (LTO)
+- ✅ Sanitizers, Coverage (`lcov` + `genhtml`)
 - ✅ Clang-format + Clang-tidy + Cppcheck + Pre-commit hook
 - ✅ GitHub Actions CI for builds, tests, docs, and formatting
 - ✅ Install targets (`find_package(...)` supported)
@@ -29,29 +29,21 @@ This template uses [CMake Presets](https://cmake.org/cmake/help/latest/manual/cm
 ### Build and Test
 
 ```bash
-cmake --preset gcc-RelWithDebInfo
-cmake --build --preset gcc-RelWithDebInfo
-ctest --preset gcc-RelWithDebInfo
+cmake --preset gcc-Release
+cmake --build --preset gcc-Release
+ctest --preset gcc-Release
 ```
 
 You can list available presets:
 ```bash
 cmake --list-presets
 ```
 
-#### Enable Sanitizers
+#### Sanitizers
 Use the special `Sanitize` build type to catch runtime issues:
 ```bash
 cmake --preset gcc-Sanitize
 cmake --build --preset gcc-Sanitize
-ctest --preset gcc-Sanitize
-```
-
-#### Link Time Optimization
-LTO is enabled via a dedicated preset:
-```bash
-cmake --preset gcc-RelWithDebInfo-lto
-cmake --build --preset gcc-RelWithDebInfo-lto
 ```
 
 #### Testing
@@ -63,9 +55,23 @@ cmake --build --preset gcc-RelWithDebInfo-lto
 
 Run tests:
 ```bash
+cmake --preset gcc-Sanitize
+cmake --build --preset gcc-Sanitize
 ctest --preset gcc-Sanitize
 ```
 
+#### Coverage
+
+This project supports code coverage analysis using `lcov` and `genhtml`. To enable coverage:
+```bash
+cmake --preset gcc-Coverage
+cmake --build --preset gcc-Coverage
+ctest --preset gcc-Coverage
+cmake --build --preset gcc-Coverage --target coverage
+```
+
+The report will be saved in `<project_root>/build/gcc-Coverage/coverage-report/index.html`.
+
 ### Code Style and Linting
 
 This project uses:
@@ -76,16 +82,17 @@ If `clang-format` or `clang-tidy` is not found, the corresponding target will be
 
 Run checks manually using custom CMake targets:
 ```bash
-cmake --build --preset gcc-RelWithDebInfo --target clang-format
-cmake --build --preset gcc-RelWithDebInfo --target clang-tidy
+cmake --preset gcc-Release
+cmake --build --preset gcc-Release --target clang-format-check
+cmake --build --preset gcc-Release --target clang-tidy
 ```
 
 ### Installation
 
 Install includes, libs, and CMake config files:
 ```bash
-cmake --preset gcc-RelWithDebInfo
-cmake --build --preset gcc-RelWithDebInfo
+cmake --preset gcc-Release
+cmake --build --preset gcc-Release
 cmake --install build/gcc-RelWithDebInfo --prefix install # or /usr/local
 ```
 
@@ -110,8 +117,8 @@ Documentation is generated using [Doxygen](https://www.doxygen.nl). Docs are bui
 
 Generate docs locally via custom CMake target:
 ```bash
-cmake --preset gcc-RelWithDebInfo
-cmake --build --preset gcc-RelWithDebInfo --target docs
+cmake --preset gcc-Release -DBUILD_DOCS=ON
+cmake --build --preset gcc-Release --target docs
 ```
 
 View documentation online: [Modern C++ template](https://ramsafin.github.io/modern-cpp-project-template/html).

app/CMakeLists.txt

@@ -6,6 +6,5 @@ target_link_libraries(${PROJECT_NAME}_app
   PRIVATE ${PROJECT_NAME}::math
 )
 
-enable_lto(${PROJECT_NAME}_app)
 enable_sanitizers(${PROJECT_NAME}_app)
 enable_strict_warnings(${PROJECT_NAME}_app)