Refactor

Author: ramsafin

.clang-tidy

@@ -1,14 +1,31 @@
+---
 Checks: >
-  google-*,
   modernize-*,
-  readability-*,
   performance-*,
-  -google-build-using-namespace,
-  -google-readability-function-size,
+  cppcoreguidelines-*,
+  readability-*,
+  misc-*,
+  bugprone-*,
   -modernize-use-trailing-return-type,
-  -readability-implicit-bool-conversion
+  -cppcoreguidelines-pro-type-const-cast
 
-WarningsAsErrors: ''
+# Treat warnings-as-errors for selected groups
+WarningsAsErrors: >
+  modernize-*,
+  performance-*
 
 FormatStyle: file
 UseColor: true
+
+CheckOptions:
+  # modernize-use-nullptr: replace 0/NULL with nullptr
+  - key:   modernize-use-nullptr.NullMacros
+    value: 'NULL'
+
+  # performance-unnecessary-value-param: catch expensive-by-value parameters
+  - key:   performance-unnecessary-value-param.AllowedTypes
+    value: 'std::string;std::vector'
+
+  # bugprone-use-after-move: catch use-after-move mistakes
+  - key:   bugprone-use-after-move.WarnOnMacros
+    value: 1

.clangd

@@ -1,6 +1,6 @@
 # .clangd
 CompileFlags:
-  Add: [-Wall, -Wextra, -Wpedantic, -std=c++23]
+  Add: [-std=c++20]
 Diagnostics:
   UnusedIncludes: Strict
   Suppress: ["-Wdeprecated-copy"]

.editorconfig

@@ -1,10 +1,25 @@
-# .editorconfig
-root = true
-
+# Default for all files
 [*]
 indent_style = space
 indent_size = 2
 end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
+
+# Tab indentation for Makefiles
+[Makefile]
+indent_style = tab
+
+# Four‑space indent for C/C++ source
+[*.{c,cpp,h,hpp}]
+indent_size = 4
+
+# Soft‑wrapped Markdown, trim trailing space only on non‑list lines
+[*.md]
+trim_trailing_whitespace = false
+max_line_length = 120
+
+# Two‑space indent for YAML and JSON
+[*.{yml,yaml,json}]
+indent_size = 2

.github/workflows/ci.yml

@@ -51,7 +51,7 @@ jobs:
       - name: Install dependencies
         run: |
           sudo apt-get -qq update
-          sudo apt-get -qq install -y clang lld gcc g++ ccache --no-install-recommends
+          sudo apt-get -qq install -y clang gcc g++ ccache --no-install-recommends
 
       - name: Cache ccache
         uses: actions/cache@v4
@@ -64,8 +64,9 @@ jobs:
       - name: Cache build directory
         uses: actions/cache@v4
         with:
-          path: build/
-          key: ${{ runner.os }}-build-${{ matrix.compiler }}-${{ matrix.build_type }}-${{ github.sha }}
+          path: build/${{ matrix.compiler }}-${{ matrix.build_type }}
+          key: |
+            ${{ runner.os }}-build-${{ matrix.compiler }}-${{ matrix.build_type }}-${{ hashFiles('**/CMakeLists.txt') }}
           restore-keys: |
             ${{ runner.os }}-build-
 
@@ -76,4 +77,4 @@ jobs:
         run: cmake --build --preset ${{ matrix.compiler }}-${{ matrix.build_type }}
 
       - name: Run tests (ctest)
-        run: ctest --preset ${{ matrix.compiler }}-${{ matrix.build_type }}
+        run: ctest --preset ${{ matrix.compiler }}-${{ matrix.build_type }} --fail-fast

.github/workflows/clang-format.yml

@@ -49,9 +49,10 @@ jobs:
         uses: actions/cache@v4
         with:
           path: build/
-          key: ${{ runner.os }}-build-${{ github.sha }}
+          key: |
+            ${{ runner.os }}-clang-format-${{ hashFiles('**/.clang-format','cmake/Tooling.cmake') }}
           restore-keys: |
-            ${{ runner.os }}-build-
+            ${{ runner.os }}-clang-format-
 
       - name: Configure with CMake Preset
         run: cmake --preset $CMAKE_PRESET_NAME -DENABLE_CLANG_FORMAT=ON

.github/workflows/clang-tidy.yml

@@ -1,23 +1,6 @@
 name: clang-tidy
 
-on:
-  push:
-    branches: [ master ]
-    paths:
-      - '**/*.cpp'
-      - '**/*.hpp'
-      - '.clang-tidy'
-      - 'cmake/Tooling.cmake'
-      - '.github/workflows/clang-tidy.yml'
-
-  pull_request:
-    branches: [ master ]
-    paths:
-      - '**/*.cpp'
-      - '**/*.hpp'
-      - '.clang-tidy'
-      - 'cmake/Tooling.cmake'
-      - '.github/workflows/clang-tidy.yml'
+on: [push, pull_request]
 
 jobs:
   lint:
@@ -47,9 +30,10 @@ jobs:
         uses: actions/cache@v4
         with:
           path: build/
-          key: ${{ runner.os }}-build-${{ github.sha }}
+          key: |
+            ${{ runner.os }}-clang-tidy-${{ hashFiles('**/CMakeLists.txt','cmake/**/*.cmake','.clang-tidy') }}
           restore-keys: |
-            ${{ runner.os }}-build-
+            ${{ runner.os }}-clang-tidy-
 
       - name: Configure project
         run: cmake --preset $CMAKE_PRESET_NAME -DENABLE_CLANG_TIDY=ON

.github/workflows/coverage.yml

@@ -6,6 +6,7 @@ on:
     paths:
       - '**/*.cpp'
       - '**/*.hpp'
+      - 'tests/**'
       - 'CMakeLists.txt'
       - 'cmake/Coverage.cmake'
       - '.github/workflows/coverage.yml'
@@ -39,15 +40,17 @@ jobs:
         uses: actions/cache@v4
         with:
           path: $CACHE_DIR
-          key: ${{ runner.os }}-ccache-${{ github.sha }}
+          key: |
+            ${{ runner.os }}-ccache-${{ hashFiles('**/CMakeLists.txt','cmake/Coverage.cmake') }}
           restore-keys: |
             ${{ runner.os }}-ccache-
 
       - name: Cache build directory
         uses: actions/cache@v4
         with:
           path: build/
-          key: ${{ runner.os }}-build-${{ github.sha }}
+          key: |
+            ${{ runner.os }}-build-${{ hashFiles('**/CMakeLists.txt','cmake/Coverage.cmake') }}
           restore-keys: |
             ${{ runner.os }}-build-
 

.gitignore

@@ -1,5 +1,9 @@
-# === CMake build artifacts ===
+# === Build Artifacts ===
+
+# CMake out-of-source dirs
 build/
+out*/
+cmake-build-*/
 CMakeFiles/
 CMakeCache.txt
 cmake_install.cmake
@@ -8,49 +12,66 @@ compile_commands.json
 install/
 !cmake/install
 
-# === Ninja build ===
+# Ninja
 *.ninja
-.ninja_deps
-.ninja_log
-rules.ninja
+.ninja_*
+
+# === IDEs & Editors ===
 
-# === VS Code ===
-.vscode/*.code-workspace
-.vscode/ipch/
-.vscode/cmakesettings.json
+# VS Code
+.vscode/
+# JetBrains
+.idea/
+*.iml
 
-# === Editor backups ===
+# Editor backups
 *~
 *.swp
 *.bak
 *.tmp
 
-# === Logs and crash reports ===
-*.log
-*.core
-
-# === clangd index ===
-.clangd/
-.cache/
-.clangd/index/
+# === OS-specific ===
+.DS_Store
+Thumbs.db
+ehthumbs.db
 
-# === Sanitizer dumps (optional) ===
+# === Tools & Packages ===
+# Sanitizer dumps
 leak*.txt
 san.*.log
 
-# === Precompiled headers (if used) ===
-*.gch
-*.pch
+# Coverage & profiler
+coverage/
+*.info
+*.gcno
+*.gcda
+profiler.*
 
-# === Conan (optional for later) ===
+# Conan & vcpkg
 conanbuildinfo.*
 .cmake/conan*
+vcpkg_installed/
+vcpkg_buildtrees/
 
-# === CTest / testing output ===
+# === Testing & Logs ===
 Testing/
 test_output/
+*.log
+*.core
+
+# === Packaging & Archives ===
+*.zip
+*.tar.gz
+*.tgz
+*.rpm
+
+# === Documentation Builds ===
+docs/_build/
+docs/html/
+docs/latex/
 
-# === Docs ===
-docs/*
-!docs/Doxyfile.in
-!docs/mainpage.md
+# === Miscellaneous ===
+tmp/
+temp/
+__pycache__/
+*.lock

CMakeLists.txt

@@ -1,5 +1,14 @@
 cmake_minimum_required(VERSION 3.23 FATAL_ERROR)
-project(modern_cpp LANGUAGES CXX VERSION 0.1.0)
+project(modern_cpp
+  LANGUAGES CXX
+  VERSION 0.1.0
+  DESCRIPTION "Modern C++ project template"
+  HOMEPAGE_URL "https://github.com/ramsafin/modern-cpp-project-template"
+)
+
+if (CMAKE_SOURCE_DIR STREQUAL CMAKE_BINARY_DIR)
+  message(FATAL_ERROR "In-source builds are not allowed! Retry in a separate build directory.")
+endif()
 
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
 
@@ -20,9 +29,6 @@ include(Helpers)
 # === Coverage ===
 include(Coverage)
 
-# === Logging ===
-include(Logging)
-
 # === Library ===
 add_subdirectory(src)
 

README.md

@@ -25,7 +25,6 @@
 - [Contributing](#contributing)
 - [License](#license)
 
-
 ## Features
 
 - **Modern C++20+**: fully enabled C++20 with support for upgrading to C++23
@@ -40,22 +39,27 @@
 - **Installation**: provides `find_package(...)` integration with proper exports
 - **CI-Ready**: GitHub Actions for builds, linting, testing, and formatting
 
-
 ## Project Structure
 
 ```text
 modern-cpp-project-template/
+├── .github/workflows/   # CI pipelines for GitHub Actions
+├── .vscode/             # VS Code workspace settings
 ├── app/                 # Optional demo application
 ├── benchmarks/          # Google Benchmark performance tests
-├── cmake/               # Custom CMake modules (warnings, sanitizers, tooling)
-├── include/             # Public headers
+├── cmake/               # Custom CMake modules (Options, Flags, Helpers, etc.)
+├── include/             # Public library headers
 ├── src/                 # Library source files
-├── tests/               # Unit tests using GoogleTest
+├── tests/               # Unit tests (GoogleTest)
 ├── .clang-format        # Formatting rules
 ├── .clang-tidy          # Static analysis configuration
-├── CMakeLists.txt       # Top-level CMake build configuration
+├── .clangd              # Clangd language server settings
+├── .editorconfig        # Editor consistency rules
+├── .gitignore           # Git ignore patterns
+├── CMakeLists.txt       # Top-level build configuration
 ├── CMakePresets.json    # Build, test, and workflow presets
-└── README.md
+├── LICENSE              # Apache 2.0 license
+└── README.md            # Project documentation
 ```
 
 ## Prerequisites