feat: clang pre-commit hook, housekeeping

Author: milsanore

.clang-tidy

@@ -0,0 +1,12 @@
+---
+Checks: >
+  clang-analyzer-*,
+  cppcoreguidelines-*,
+  modernize-*,
+  performance-*,
+  google-*,
+  -google-runtime-int,
+  -google-readability-braces-around-statements,
+  -modernize-use-trailing-return-type
+
+ExtraArgs: ['-std=c++20']

.githooks/pre-commit

@@ -47,6 +47,12 @@ test:
 	ctest --preset=debug
 	lcov --gcov-tool gcov --capture --directory . --output-file lcov.info
 
+## tidy: 🧹 tidy things up before committing code
+.PHONY: tidy
+tidy:
+	find src/ tests/ -name '*.cpp' | xargs clang-tidy -p build/Debug --fix --format-style=.clang-format
+	find src/ tests/ \( -name '*.cpp' -o -name '*.hpp' -o -name '*.c' -o -name '*.h' \) -exec clang-format -i {} +	
+
 ## build-release: 🔨🔨 compile (prod)
 .PHONY: build-release
 build-release:

Makefile

@@ -9,50 +9,64 @@
 # trader.cpp
 a proof-of-concept, showcasing some c++ coding combined with some fintech concepts
 
-## RUN REQUIREMENTS
+## Run Requirements
 - a Binance account, with an Ed25519 token that has FIX read permissions enabled 
-- `stunnel` or a local proxy, for TLS encryption
+- `stunnel` for TLS encryption (or a local proxy)
 
-## BUILD REQUIREMENTS
+## Build Requirements
 - C++20
 - `Conan` (and a conan profile)
 - `CMake`
+- `ninja`
 
-## DEV REQUIREMENTS
+## Dev Requirements
+- `make` (convenience)
 - `clang-tidy`
 - `clang-format`
 - `lcov`
 
-## BUILD AND RUN
+## Build and Run
 (NB: this app uses `make` as a task runner, but it's not essential)
 1. copy `.env.example` to `.env`, and set your public/private keys
 2. run an SSL tunnel (e.g. `stunnel binance/stunnel_prod.conf`)
 3. `make init`
 4. `make build-debug`
 5. `make withenv RECIPE=run-debug`
 
-## TEST
+## Test
 `make test`
 
-## HELP
+## Debug
+- vscode
+  - app and test debug profiles are pre-configured in the following files:
+    - `.vscode/launch.json`
+    - `.vscode/tasks.json`
+- intellij (clion)
+  - enable the `debug` CMake profile
+
+## Help
 `make`
 
+## Cloud Config
+- Sonarcloud (click the badge)
+- Codecov (click the badge)
+
 
-# AIM
+# Aims
 
-## FUNCTIONAL
+## Functional
 - ✅ create a FIX connection to Binance
 - ✅ subscribe to price updates
 - create a basic trading signal (e.g. standard deviations)
 - fire an order
 - test in the Binance test environment
 
-
-## NON-FUNCTIONAL
+## Non-functional
 - ✅ basic cpp app to start with
 - ✅ makefile and build chain
 - ✅ package management
 - ✅ debugging
+- ✅ single-threaded to start with, then re-architect (and mermaid diagram)
 - ✅ UI
   - ✅ publish messages to thread-safe queue
   - ✅ consume messages from thread-safe queue on a worker thread
@@ -62,47 +76,50 @@ a proof-of-concept, showcasing some c++ coding combined with some fintech concep
     - ✅ fast
     - structured
     - basic schema (severity, correlationId)
-- ✅ dependency injection
-- ✅ single-threaded to start with, then re-architect (and mermaid diagram)
-- ✅ code formatting / clang-format
+- code quality
+  - ✅ clang-format
+    - ✅ configure editor to auto-format
+    - ✅ fail commits if not formatted
+    - ✅ fail builds if not formatted
+  - clang-tidy
+    - all files tidied
+    - configured clang-tidy => clang-format
+    - fail commits/merges if not tidy
+    - fail builds if not tidy
   - ✅ git hooks
   - ✅ integrated into build pipeline
-  - ✅ coverage badge
-- ✅ custom docker build image with all dependencies (for faster pipelines)
-- ✅ static code analysis
+  - ✅ badges
   - ✅ sonarcloud integrated into build pipeline
-- clang-tidy
-- decimal type
-- sparse arrays
-- release binaries on github
-- ccache.dev
-- zeromq + protobufs?
-- valgrind/cachegrind
-- github releases
-- local github action runner
-- sonarqube integration
-- nix virtual environment
-
-# STANDARDS
-- high unit-test coverage
-- static code analysis
-- configure debugging 
-- git use
-- integration test with mocked Binance
-- load test with mocked Binance (k6?)
-- profiling
-- github action
-    - containerised integration tests / dind
+  - sonarcloud coverage
+- pipeline
+  - ✅ custom docker build image with all dependencies (hosted on GHCR for faster pipelines)
+  - nix
+  - ccache (faster pipelines)
+  - github releases
+  - local github action runner (`act`)
+  - containerised integration tests / dind
+- testing
+  - ✅ dependency injection
+  - integration test with mocked Binance
+- performance
+  - profiling (valgrind/cachegrind)
+  - load test with mocked Binance server (k6?)
+  - sparse arrays
+  - memory-mapped files
 - observability
-    - opentelemetry
-    - grafana+tempo via docker-compose
+  - opentelemetry
+  - grafana+tempo via docker-compose
 - versioning
-  - conventional commits
+  - master branch merge check for conventional commit message (e.g. regex)
+    - maybe a merge git gook check
   - automated semantic versioning
   - github-changelog-generator
-  - master branch merge check for conventional commit message
-  - maybe a git gook check for merges
-- memory-mapped files
+- other
+  - decimal type
+  - zeromq + protobufs?
+  - shellcheck?
+- deployment
+  - terraform
 
-# CREDITS
+# Credits
 - https://github.com/binance/binance-fix-connector-python

README.md

@@ -0,0 +1,31 @@
+#!/bin/bash
+
+################################################################
+# check_clang_format.sh
+# checks for any formatting issues and errors out.
+# does not modify files in-place.
+################################################################
+
+set -euo pipefail
+
+echo ">> Checking for clang-format issues..."
+
+CLANG_FORMAT_BIN="clang-format"
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+
+files=$(find "$SCRIPT_DIR"/../src/ "$SCRIPT_DIR"/../tests/ \( -name '*.cpp' -o -name '*.hpp' -o -name '*.c' -o -name '*.h' \))
+format_errors=0
+for file in $files; do
+    if [ -f "$file" ]; then
+        if ! diff -q <($CLANG_FORMAT_BIN "$file") "$file" >/dev/null; then
+            echo "clang-format issues found in file, exiting. file: [$file]"
+            format_errors=1
+            break
+        fi
+    fi
+done
+
+if [ $format_errors -ne 0 ]; then
+    echo "ERROR: clang-format found unformatted code. Try \`make tidy\`"
+    exit 1
+fi

hooks/check_clang_format.sh

@@ -0,0 +1,40 @@
+#!/bin/bash
+
+################################################################
+# check_clang_tidy.sh
+# checks for any lint warnings and errors out.
+# does not modify files in-place.
+################################################################
+
+set -euo pipefail
+
+echo ">> Checking for clang-tidy warnings..."
+
+CLANG_TIDY_BIN="clang-tidy"
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+BUILD_DIR="$SCRIPT_DIR/../build/Debug"
+
+if [ ! -f "$BUILD_DIR/compile_commands.json" ]; then
+    echo "ERROR: compile_commands.json not found in $BUILD_DIR"
+    echo "Run: cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -B $BUILD_DIR"
+    exit 1
+fi
+
+files=$(find "$SCRIPT_DIR"/../src/ "$SCRIPT_DIR"/../tests/ \( -name '*.cpp' -o -name '*.c' \))
+tidy_errors=0
+for file in $files; do
+    echo "Running clang-tidy on $file"
+    $CLANG_TIDY_BIN "$file" -p "$BUILD_DIR" > tidy_output.txt 2>&1 || true
+    if grep -q "warning:" tidy_output.txt; then
+        echo "clang-tidy warnings found in file, exiting. file: [$file] warnings:"
+        cat tidy_output.txt
+        tidy_errors=1
+        break
+    fi
+done
+rm tidy_output.txt
+
+if [ $tidy_errors -ne 0 ]; then
+    echo "ERROR: clang-tidy found warnings. Try \`make tidy\`"
+    exit 1
+fi

hooks/check_clang_tidy.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+################################################################
+# pre-commit.sh
+# Fails the commit on any linting/formatting errors.
+# NB: file paths are relative to the script location,
+# so the script can be executed from any path
+################################################################
+
+set -euo pipefail
+
+DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+
+# Run subscripts
+echo "Running strict pre-commit checks on src/ and tests/"
+bash "$DIR/check_clang_tidy.sh"
+bash "$DIR/check_clang_format.sh"
+echo "✅ Pre-commit checks passed on full codebase."