feat: clang-format and github action

Author: milsanore

.clang-format

@@ -0,0 +1,3 @@
+BasedOnStyle: Google
+IndentWidth: 2
+ColumnLimit: 90

.githooks/pre-commit

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+# Find all staged C++ source and header files (you can modify this pattern)
+files=$(git diff --cached --name-only --diff-filter=AM | grep -E '\.cpp$|\.h$')
+
+# If there are no relevant files, exit early
+if [ -z "$files" ]; then
+    exit 0
+fi
+
+# Run clang-format on all staged files
+echo "Running clang-format on staged files..."
+for file in $files; do
+    clang-format -i "$file"  # Format the file in place
+    git add "$file"          # Re-add the formatted file to the staging area
+done
+
+echo "clang-format done."
+
+# Optionally: Run tests or other checks here, like 'make lint'
+
+exit 0

.github/workflows/build.yml

@@ -8,33 +8,50 @@ on:
     branches: [ master ]
 
 jobs:
-  build:
+  format:
     runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up clang-format
+        run: sudo apt update && sudo apt install -y clang-format
+
+      - name: Check code formatting
+        run: |
+          set -e
+          CHANGED_FILES=$(find src tests -name '*.cpp' -o -name '*.h')
+          FORMAT_ERRORS=0
+          for file in $CHANGED_FILES; do
+            clang-format --dry-run --Werror "$file" || FORMAT_ERRORS=1
+          done
+          if [ "$FORMAT_ERRORS" -ne 0 ]; then
+            echo "Code is not properly formatted. Please run clang-format."
+            exit 1
+          fi
 
+  build_and_test:
+    needs: format
+    runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
 
-      - name: Cache Conan
+      - name: Restore Conan cache
         uses: actions/cache@v4
         with:
           path: ~/.conan2
           key: ${{ runner.os }}-conan-${{ hashFiles('conanfile.*') }}
           restore-keys: |
             ${{ runner.os }}-conan-
-      
-      - name: Set up build tools
+
+      - name: Install dependencies and build
         run: |
+          set -e
           sudo apt update && sudo apt install -y g++
           pip install conan
           conan profile detect --force
-
-      - name: Build
-        run: |
           conan install . --build=missing -s build_type=Debug
           cmake --preset=conan-debug
           cmake --build --preset=conan-debug
-
-      - name: Test
-        run: |
           ctest --test-dir build/Debug --output-on-failure

.gitignore

@@ -1,16 +1,19 @@
 .idea/
 .venv/
 .trash/
-
 build/
 binance/keys/
 qf_files/
 qf_logs/
 logs/
 
+# ENVIRONMENT
 .env
 .env.*
 
+# COVERAGE
+lcov.info
+
 # TODO: Understand the auto-generation of this file
 CMakeUserPresets.json
 

.vscode/settings.json

@@ -1,4 +1,5 @@
 {
 	"C_Cpp.default.configurationProvider": "ms-vscode.cmake-tools",
-	"C_Cpp.default.compileCommands": "${workspaceFolder}/build/Debug/compile_commands.json"
-}
+	"C_Cpp.default.compileCommands": "${workspaceFolder}/build/Debug/compile_commands.json",
+	"editor.formatOnSave": true
+}

CMakeLists.txt

@@ -5,8 +5,8 @@ set(CMAKE_CXX_STANDARD 23)
 set(CMAKE_CXX_STANDARD_REQUIRED YES)
 
 ############################################
-# Conan-generated toolchain setup
 
+# Conan-generated toolchain setup
 include(${CMAKE_BINARY_DIR}/conan_toolchain.cmake OPTIONAL RESULT_VARIABLE _found_toolchain)
 if(_found_toolchain)
     message(STATUS "Conan toolchain included")
@@ -22,14 +22,13 @@ find_package(libsodium REQUIRED)
 find_package(spdlog REQUIRED)
 
 ############################################
-# Collect source files
 
+# Collect source files
 file(GLOB_RECURSE ALL_SOURCES "src/*.cpp")
 # Separate main.cpp from the rest of the sources
 list(FILTER ALL_SOURCES EXCLUDE REGEX ".*main\\.cpp$")
 set(SOURCES ${ALL_SOURCES})
 
-############################################
 # Create core logic library
 add_library(traderlib STATIC ${SOURCES})
 
@@ -40,20 +39,33 @@ target_link_libraries(traderlib PRIVATE --coverage)
 
 # Link dependencies to the library (so both exe and tests get them)
 target_link_libraries(traderlib PUBLIC
-        concurrentqueue::concurrentqueue
-        ftxui::ftxui
-        OpenSSL::SSL
-        OpenSSL::Crypto
-        quickfix::quickfix
-        libsodium::libsodium
-        spdlog::spdlog
+    concurrentqueue::concurrentqueue
+    ftxui::ftxui
+    OpenSSL::SSL
+    OpenSSL::Crypto
+    quickfix::quickfix
+    libsodium::libsodium
+    spdlog::spdlog
 )
 
 ############################################
 # Create main executable
 add_executable(tradercpp "src/main.cpp")
 target_link_libraries(tradercpp PRIVATE traderlib)
 
+############################################
+
+# Run clang-format on all source files before building
+add_custom_command(
+    TARGET tradercpp
+    PRE_BUILD
+    COMMAND clang-format -i ${CMAKE_SOURCE_DIR}/src/**/*.cpp ${CMAKE_SOURCE_DIR}/src/**/*.h
+         && clang-format -i ${CMAKE_SOURCE_DIR}/tests/**/*.cpp ${CMAKE_SOURCE_DIR}/tests/**/*.h
+    COMMENT "Running clang-format on all source and header files"
+)
+
+# set(CMAKE_CXX_CLANG_TIDY "clang-tidy;-config-file=.clang-tidy;-checks=*")
+
 ############################################
 # Enable `ctest`
 enable_testing()

Makefile

@@ -22,6 +22,7 @@ withenv:
 ## init: 🏌️ initialize the project, fetch dependencies
 .PHONY: init
 init:
+	test -e .git/hooks/pre-commit || ln -s ../../.githooks/pre-commit .git/hooks/pre-commit
 	rm -rf build && mkdir build
 	python3 -m venv .venv
 	source .venv/bin/activate && \
@@ -49,7 +50,7 @@ build-release:
 	cmake --preset=conan-release
 	cmake --build --preset=conan-release
 
-## run-debug: 🏃‍♂️ run the app (debug) (don't forget withenv)
+## run-debug: 🏃‍♂️ run the app (debug) (don't forget `withenv`)
 .PHONY: run-debug
 run-debug:
 	build/Debug/tradercpp

README.md

@@ -6,17 +6,21 @@ a proof-of-concept, showcasing some c++ coding combined with some fintech concep
 	width="250" />
 
 ## REQUIREMENTS
+- a Binance account, with an Ed25519 token that has FIX read permissions enabled 
 - C++20
 - `Conan` (and a conan profile)
 - `CMake`
-- a local proxy for TLS encryption (e.g. `stunnel`)
-- a Binance account, with an Ed25519 token that has FIX read permissions enabled 
+- `stunnel` or a local proxy, for TLS encryption
+
+## DEV REQUIREMENTS
+- `clang-tidy`
+- `clang-format`
 - `lcov`
 
 ## 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 (`stunnel binance/stunnel_prod.conf`)
+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`
@@ -61,11 +65,16 @@ a proof-of-concept, showcasing some c++ coding combined with some fintech concep
 - ccache.dev
 - zeromq + protobufs?
 - valgrind/cachegrind
+- code formatting / auto-formatter
+  - ✅ clang-format
+  - ✅ git hooks
+  - ✅integrated into build pipeline
+- clang-tidy
+- github releases
+- custom docker build image with all dependencies
 
 # STANDARDS
 - high unit-test coverage + badge
-- code formatting / auto-formatter
-  - clang?
 - static code analysis
 - configure debugging 
 - git use
@@ -77,8 +86,10 @@ a proof-of-concept, showcasing some c++ coding combined with some fintech concep
 - observability
     - opentelemetry
     - grafana+tempo via docker-compose
-- conventional commits
-- automated semantic versioning
+- versioning
+  - conventional commits
+  - automated semantic versioning
+  - github-changelog-generator
 - memory-mapped files
 
 # CREDITS

docs/DESIGN.md

@@ -0,0 +1,15 @@
+# DESIGN
+```mermaid
+sequenceDiagram
+    participant T1 as Thread 1<br>(Main + UI)
+    participant T2 as Thread 2<br>(FIX Worker)
+    participant T3 as Thread 3<br>(UI Worker)
+
+    T1->>T2: Start FIX Worker
+    T1->>T3: Start UI Worker
+    T2-->>T2: connect+subscribe<br>+push to <queue>
+    T2->>T3: pull from <queue>
+    T3->>T1: request render
+    T2-->>T1: Thread 1 done
+    T3-->>T1: Thread 2 done
+```