1aa3493e7d
This commit closes the structural-tests work on PR #18. Every gate in `run-all.sh --fast` now passes end-to-end on the canonical dev machine. New gates ───────── 1. shellcheck (scripts/quality/shellcheck.sh) * Scans every `scripts/**/*.sh` at severity=warning+ * 16 scripts inspected; cleanup pass took the tree from 7 findings (SC2164 + SC2034) to 0 findings. 2. cppcheck (scripts/quality/cppcheck.sh) * Complementary static analyser to clang-tidy; different heuristics, fewer false-positives on heavy CGAL/Eigen templates. * Default severity warning+, --strict adds style, --all = everything. * Suppresses 4 noise classes (missingIncludeSystem, etc.) explicitly. 3. .editorconfig * Cross-IDE fallback for editors that don't honour clang-format. * Covers Markdown (preserve trailing whitespace), Python, YAML, JSON, shell, Makefile (tabs) — the file types clang-format doesn't cover. 4. CONFORMALLAB_WARNINGS_AS_ERRORS CMake option * Off by default → regular builds don't break on new GCC warnings. * `-DCONFORMALLAB_WARNINGS_AS_ERRORS=ON` adds `-Werror`, intended for CI promotion-track and sanitizer runs. Dependency audit (doc/architecture/dependencies.md) ──────────────────────────────────────────────────── New single-source-of-truth document listing: * what the library requires (Eigen + CGAL + Boost — all header-only) * what tests require (auto-fetched GTest, no system install) * what each quality tool is for, install command per OS, and behaviour when missing (each gate exits 2 = SKIP, run-all recognises this and continues) * a verification recipe that strips PATH down and shows the library still configures + builds + tests cleanly with zero quality tools installed. run-all.sh enhanced ─────────────────── * Recognises "tool not in PATH" → SKIP (not FAIL). * Summary now reports `passed / skipped / failed` separately. Bug fixes uncovered by the sweep ──────────────────────────────── * sanitizers.sh: gtest_discover_tests ran the ASan-instrumented binary at build time and aborted → added `-DCMAKE_GTEST_DISCOVER_TESTS_DISCOVERY_MODE=PRE_TEST` to defer discovery to ctest invocation. Now 23/23 sanitizer-instrumented tests pass. * clang-tidy.sh on macOS: brew-installed clang-tidy couldn't find Apple SDK system headers (<cmath>, <complex>, …) → added `--extra-arg=-isysroot $(xcrun --show-sdk-path)` on Darwin. * clang-tidy.sh: needed `-DWITH_CGAL_TESTS=ON` in compile_commands generation so CGAL include paths are part of at least one compile entry. Now resolves CGAL/Surface_mesh.h etc. * clang-tidy.sh: viewer-only headers (`viewer_utils.h`, `mesh_utils.hpp`) excluded — they need `WITH_VIEWER=ON` + system GLFW/libigl that the lint build doesn't drag in. * `.codespellrc`: extended ignore list (recognise, signalled, modelled, travelled, …) for British-English consistency across own writing. Final state — local quality block on this commit, this branch: ✅ License headers (66/66 carry MIT SPDX) ✅ CGAL conventions (0/6 violations on 6 CGAL headers) ✅ clang-format drift (0 drift) ✅ cmake-format/-lint (0 drift, 0 lint findings) ✅ codespell (0 typos in scope) ✅ shellcheck (0 findings across 16 .sh files) ✅ cppcheck (warning+ severity clean) ✅ Markdown links (122/122 resolve) ✅ Sanitizers (ASan+UBSan) (23/23 fast tests pass) ✅ clang-tidy (35 headers inspected, 0 findings) Library standalone-ness verified: env -i PATH=... cmake -S code -B /tmp/build-standalone cmake --build /tmp/build-standalone --target conformallab_tests ctest -E '^cgal\.' → all green Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
97 lines
2.6 KiB
Bash
Executable File
97 lines
2.6 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# scripts/quality/clang-format.sh
|
|
#
|
|
# Verify every source file under code/{include,src,tests} matches the
|
|
# project's `.clang-format` policy. Runs in dry-run mode by default —
|
|
# only reports diffs; never edits files.
|
|
#
|
|
# Pass `--fix` to apply the suggested formatting in place.
|
|
#
|
|
# Local-only. Promotion to CI is intended once the existing tree is
|
|
# 100 %-conformant; today we report drift but don't fail (the script
|
|
# exits non-zero only with `--strict`).
|
|
#
|
|
# Usage:
|
|
# bash scripts/quality/clang-format.sh # dry-run, exit 0 always
|
|
# bash scripts/quality/clang-format.sh --strict # dry-run, exit 1 on drift
|
|
# bash scripts/quality/clang-format.sh --fix # apply changes
|
|
#
|
|
# Exit codes:
|
|
# 0 no drift, or drift but --strict not set
|
|
# 1 drift detected AND --strict (or fixes applied AND --fix)
|
|
# 2 prerequisite missing
|
|
|
|
set -uo pipefail
|
|
ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
|
|
cd "$ROOT" || exit 2
|
|
|
|
command -v clang-format >/dev/null 2>&1 || {
|
|
echo "FAIL: clang-format not in PATH." >&2
|
|
echo " macOS: brew install clang-format" >&2
|
|
echo " Linux: sudo apt install clang-format" >&2
|
|
exit 2
|
|
}
|
|
|
|
STRICT=0
|
|
FIX=0
|
|
for arg in "$@"; do
|
|
case "$arg" in
|
|
--strict) STRICT=1 ;;
|
|
--fix) FIX=1 ;;
|
|
*) echo "Unknown arg: $arg" >&2; exit 2 ;;
|
|
esac
|
|
done
|
|
|
|
FILES_LIST="$(find code/include code/src code/tests \
|
|
\( -name "*.h" -o -name "*.hpp" -o -name "*.cpp" \) \
|
|
-type f 2>/dev/null \
|
|
| grep -v "^code/deps/" \
|
|
| grep -v " 2\." \
|
|
| sort)"
|
|
|
|
n_total=0
|
|
n_drift=0
|
|
drift_list=""
|
|
while IFS= read -r f; do
|
|
[ -z "$f" ] && continue
|
|
n_total=$((n_total + 1))
|
|
if [ "$FIX" -eq 1 ]; then
|
|
clang-format -i "$f"
|
|
else
|
|
# --dry-run + -Werror sets non-zero exit when changes would be made.
|
|
if ! clang-format --dry-run -Werror "$f" >/dev/null 2>&1; then
|
|
n_drift=$((n_drift + 1))
|
|
drift_list="$drift_list $f
|
|
"
|
|
fi
|
|
fi
|
|
done <<EOF
|
|
$FILES_LIST
|
|
EOF
|
|
|
|
echo "clang-format ($(clang-format --version | head -1))"
|
|
echo "Scanned $n_total source files."
|
|
|
|
if [ "$FIX" -eq 1 ]; then
|
|
echo "FIX mode: applied formatting in place."
|
|
exit 0
|
|
fi
|
|
|
|
if [ "$n_drift" -gt 0 ]; then
|
|
echo
|
|
echo "DRIFT: $n_drift file(s) do not match .clang-format policy:"
|
|
printf "%s" "$drift_list"
|
|
echo
|
|
echo "Recovery:"
|
|
echo " bash scripts/quality/clang-format.sh --fix # apply"
|
|
echo " git diff # review"
|
|
if [ "$STRICT" -eq 1 ]; then
|
|
exit 1
|
|
fi
|
|
echo " (--strict not set → exiting 0 anyway)"
|
|
exit 0
|
|
fi
|
|
|
|
echo "OK: every file matches .clang-format policy."
|
|
exit 0
|