refactor all

Author: tragisch

.bazelrc

@@ -1,72 +1,146 @@
-# build
-# ld: warning: -undefined dynamic_lookup may not work with chained fixups
-# temporary solution: https://github.com/bazelbuild/bazel/issues/16413
-# build --linkopt=-Wl,-no_fixup_chains
-build --platforms=//config/platforms:macos_arm64_platform
-
-# Gcov config
-# build:gcov --copt -fprofile-arcs 
-# build:gcov --copt -ftest-coverage
-
+####################################
+# General Bazel Configuration
+####################################
 
-###############################
-#   test                      #
-###############################
+common --color=yes
+common --curses=yes
 
-test --test_verbose_timeout_warnings 
-test --verbose_failures
-test --keep_going 
-test --test_output=all
+####################################
+# Default Platform (macOS ARM64)
+####################################
 
-###############################
-# sanitizer                   #
-###############################
+build --platforms=//config/platforms:macos_arm64_platform
 
-build:asan --strip=never
-build:asan --copt -fsanitize=address
-build:asan --copt -DADDRESS_SANITIZER
-build:asan --copt -O1
-build:asan --copt -g
-build:asan --copt -fno-omit-frame-pointer
-build:asan --linkopt -fsanitize=address
+####################################
+# Compiler & Linker Warnings
+####################################
 
-# do not use in production code:
-build --config=asan
+build --copt=-Wall
+build --copt=-Wextra
+build --copt=-Wpedantic
+build --copt=-Wno-unused-parameter
+build --copt=-Werror=implicit-function-declaration
 
-###############################
-# Profile                     #
-###############################
+####################################
+# Cache Configuration
+####################################
 
-build --generate_json_trace_profile
+build --disk_cache=.cache/bazel_cache
+build --workspace_status_command=tools/scripts/workspace_status.sh
 
-###############################
-# macOS SDK Version           #
-###############################
+####################################
+# Test Configuration
+####################################
 
-# build --macos_sdk_version=15.1
+test --test_verbose_timeout_warnings
+test --verbose_failures
+test --keep_going
+test --test_output=all
 
-###############################
-# Output                      #
-###############################
+####################################
+# Debug Build (with ASAN/UBSAN)
+####################################
+
+build:debug --compilation_mode=dbg
+build:debug --strip=never
+build:debug --copt=-O0
+build:debug --copt=-g
+build:debug --copt=-fno-omit-frame-pointer
+build:debug --copt=-fsanitize=address
+build:debug --copt=-fsanitize=undefined
+build:debug --linkopt=-fsanitize=address
+build:debug --linkopt=-fsanitize=undefined
+build:debug --define=DEBUG=1
+build:debug --features=layering_check
+build:debug --sandbox_debug
+
+test:debug --config=debug
+
+####################################
+# Release Build (Optimized)
+####################################
+
+build:opt --compilation_mode=opt
+build:opt --strip=always
+build:opt --copt=-O3
+build:opt --define=NDEBUG=1
+build:opt --copt=-march=native
+
+####################################
+# Profile/Report Build
+####################################
+
+build:profile --compilation_mode=opt
+build:profile --copt=-O2
+build:profile --copt=-g
+build:profile --copt=-ftime-report
+build:profile --profile=profile.gz
+build:profile --generate_json_trace_profile
+
+####################################
+# Benchmark Build
+####################################
+
+build:benchmark --compilation_mode=opt
+build:benchmark --strip=always
+build:benchmark --define=NDEBUG=1
+build:benchmark --copt=-O3
+build:benchmark --copt=-march=native
+
+test:benchmark --config=benchmark
+
+####################################
+# Code Coverage (LLVM Coverage)
+####################################
+
+coverage --combined_report=lcov
+coverage --instrumentation_filter="^lib/.*"
+coverage --experimental_use_llvm_covmap
+coverage --copt=-fprofile-instr-generate
+coverage --copt=-fcoverage-mapping
+coverage --copt=-ffile-prefix-map=$(PWD)=.
+coverage --copt=-fdebug-prefix-map=$(PWD)=.
+coverage --linkopt=-fprofile-instr-generate
+coverage --linkopt=-fcoverage-mapping
+coverage --experimental_generate_llvm_lcov
+
+####################################
+# Static Analysis (clang-tidy)
+####################################
+
+build:tidy --aspects=@bazel_tools//tools/cpp:cc_code_coverage.aspect
+build:tidy --features=layering_check
+build:tidy --copt=-fdiagnostics-color=always
+
+####################################
+# Linux with Homebrew LLVM
+####################################
+
+build:linux_llvm --action_env=CC=/opt/homebrew/opt/llvm/bin/clang
+build:linux_llvm --action_env=CXX=/opt/homebrew/opt/llvm/bin/clang++
+build:linux_llvm --action_env=BAZEL_USE_CPP_ONLY_TOOLCHAIN=1
+build:linux_llvm --cxxopt=-stdlib=libc++
+build:linux_llvm --linkopt=-fuse-ld=lld
+build:linux_llvm --platforms=@platforms//os:linux
+build:linux_llvm --cpu=x86_64
+
+test:linux_llvm --config=linux_llvm
+
+####################################
+# Heap Dump on OOM
+####################################
+
+build --heap_dump_on_oom
+
+####################################
+# Query Output Format
+####################################
 
-# A more useful default output mode for bazel query, which
-# prints "ng_module rule //foo:bar" instead of just "//foo:bar".
 query --output=label_kind
 
-###############################
-# Build Debug                 #
-###############################
-
-# build --compilation_mode=dbg --spawn_strategy=local
-
-###############################
-# Coverage                  #
-###############################
+####################################
+# Output Filter
+####################################
 
-# # Use Clang as the compiler
-build --compiler=clang
-build --collect_code_coverage
-build --copt=-fprofile-instr-generate
-build --copt=-fcoverage-mapping
-build --linkopt=-fprofile-instr-generate
-build --linkopt=-fcoverage-mapping
+# Suppresses most of the build output, leaving just the summary line
+# build --output_filter=^$ # Uncomment for cleaner output

.envrc

@@ -0,0 +1,21 @@
+# direnv configuration for automatic environment setup
+# Install direnv: https://direnv.net/docs/installation.html
+# Usage: direnv allow (after editing this file)
+
+# Load environment from .env if it exists
+if [ -f .env ]; then
+    source .env
+fi
+
+# Set default compiler to clang/clang++ from Homebrew
+export CC=$(which clang)
+export CXX=$(which clang++)
+
+# Add Bazel output to PATH (for easy access to built binaries)
+export PATH="$(pwd)/bazel-bin:$PATH"
+
+# Optional: Set Bazel flags for this workspace
+# export BAZELFLAGS="--config=debug"
+
+# Show direnv status
+echo "✓ C Template environment loaded (direnv)"

BUILD

@@ -1,18 +1,14 @@
-# identify missing license headers "bazel run //:license_test"
-license_test(
-    name = "license_test",
-    timeout = "short",
-    ignore = [".dir-locals.el"],
-    marker = "//:MODULE.bazel",
-)
+"""Root build file for C Template project."""
+
+load("@hedron_compile_commands//:refresh_compile_commands.bzl", "refresh_compile_commands")
 
-# installer like make install: bazel run //:matrix_installer -- /your/installation/path
-installer(
-    name = "matrix_installer",
-    data = [
-        "//:LICENSE.txt",  # if available
-        "//src:matrix",  # the target to be installed
-        "//src:matrix_header",  # must be collected in a filegroup
-    ],
-    system_integration = False,  # set "True" symlink to /usr/local/lib and /usr/local/include
+# Refresh compile_commands.json for IDE integration
+# Usage: bazel run //:refresh_compile_commands
+refresh_compile_commands(
+    name = "refresh_compile_commands",
+    targets = {
+        "//lib/...": "",
+        "//app/...": "",
+        "//tests/...": "",
+    },
 )

MODULE.bazel

@@ -13,17 +13,46 @@ For more details, please check https://github.com/bazelbuild/bazel/issues/18958
 
 module(
     name = "template",
-    version = "0.0.2",
+    version = "0.1.0",
 )
 
+######################################################################
+# Core Build Tools & Platforms
+######################################################################
+
 bazel_dep(name = "platforms", version = "0.0.11")
-bazel_dep(name = "rules_cc", version = "0.1.1")
+bazel_dep(name = "rules_cc", version = "0.1.2")
 bazel_dep(name = "bazel_skylib", version = "1.7.1")
 bazel_dep(name = "cgrindel_bazel_starlib", version = "0.25.0")
 bazel_dep(name = "rules_shell", version = "0.4.0")
-
 bazel_dep(name = "depend_on_what_you_use", version = "0.8.0")
 
+######################################################################
+# LLVM Toolchain (for consistent C/C++ across macOS & Linux)
+######################################################################
+
+bazel_dep(name = "toolchains_llvm", version = "1.6.0")
+
+llvm = use_extension("@toolchains_llvm//toolchain/extensions:llvm.bzl", "llvm")
+llvm.toolchain(llvm_version = "20.1.0")
+use_repo(llvm, "llvm_toolchain")
+use_repo(llvm, "llvm_toolchain_llvm")
+
+register_toolchains("@llvm_toolchain//:all")
+
+######################################################################
+# Apple Support (for macOS/iOS)
+######################################################################
+
+bazel_dep(name = "apple_support", version = "1.23.1")
+
+######################################################################
+# Testing & Development Tools
+######################################################################
+
+bazel_dep(name = "google_benchmark", version = "1.9.2")
+bazel_dep(name = "rules_foreign_cc", version = "0.14.0")
+
 #############################
 # Hedron's Compile Commands Extractor for Bazel
 #############################
@@ -33,8 +62,8 @@ bazel_dep(name = "depend_on_what_you_use", version = "0.8.0")
 bazel_dep(name = "hedron_compile_commands", dev_dependency = True)
 git_override(
     module_name = "hedron_compile_commands",
-    remote = "https://github.com/hedronvision/bazel-compile-commands-extractor.git",
     commit = "4f28899228fb3ad0126897876f147ca15026151e",
+    remote = "https://github.com/hedronvision/bazel-compile-commands-extractor.git",
 )
 
 #############################
@@ -44,15 +73,16 @@ git_override(
 bazel_dep(name = "phst_license_test", version = "0", dev_dependency = True)
 git_override(
     module_name = "phst_license_test",
-    tag = "0.0.1",
     remote = "https://github.com/phst/license_test.git",
+    tag = "0.0.1",
 )
 
-#############################
-# Load external non-Bazel libraries
-#############################
+######################################################################
+# Load external non-Bazel libraries (Unity, dbg-macro, etc)
+######################################################################
 
 http_archive = use_repo_rule("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
+
 git_repository = use_repo_rule("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository")
 
 # unity - A simple unit testing library for C.
@@ -69,7 +99,7 @@ http_archive(
 # dbg-macro: A simple debug macro for C.
 git_repository(
     name = "dbg-macro",
+    build_file = "@//:third_party/dbg-macro.BUILD",
     commit = "b949858d9dff4886e68f1049270aad1b3fa7ab81",
     remote = "https://github.com/eerimoq/dbg-macro.git",
-    build_file = "@//:third_party/dbg-macro.BUILD",
 )