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>
80 lines
2.1 KiB
Bash
Executable File
80 lines
2.1 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# scripts/quality/shellcheck.sh
|
|
#
|
|
# Run shellcheck across every Bash script we own (scripts/**/*.sh).
|
|
# Skips the macOS duplicate artefacts (` 2.sh`).
|
|
#
|
|
# Local-only. CI promotion once every script is shellcheck-clean.
|
|
#
|
|
# Usage:
|
|
# bash scripts/quality/shellcheck.sh # warn + advisory exit 0
|
|
# bash scripts/quality/shellcheck.sh --strict # fail on any finding
|
|
#
|
|
# Exit codes:
|
|
# 0 no findings, or findings but --strict not set
|
|
# 1 --strict was set and shellcheck reported findings
|
|
# 2 prerequisite missing
|
|
|
|
set -uo pipefail
|
|
ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
|
|
cd "$ROOT" || exit 2
|
|
|
|
command -v shellcheck >/dev/null 2>&1 || {
|
|
echo "FAIL: shellcheck not in PATH." >&2
|
|
echo " macOS: brew install shellcheck" >&2
|
|
echo " Linux: sudo apt install shellcheck" >&2
|
|
exit 2
|
|
}
|
|
|
|
STRICT=0
|
|
for arg in "$@"; do
|
|
case "$arg" in
|
|
--strict) STRICT=1 ;;
|
|
*) echo "Unknown arg: $arg" >&2; exit 2 ;;
|
|
esac
|
|
done
|
|
|
|
FILES="$(find scripts -name "*.sh" -type f 2>/dev/null \
|
|
| grep -v " 2\.sh" \
|
|
| sort)"
|
|
|
|
if [ -z "$FILES" ]; then
|
|
echo "FAIL: no shell scripts found under scripts/" >&2
|
|
exit 2
|
|
fi
|
|
|
|
echo "shellcheck ($(shellcheck --version | sed -n '2p'))"
|
|
echo "Scanning shell scripts under scripts/"
|
|
echo
|
|
|
|
n_total=0
|
|
n_with_findings=0
|
|
total_findings=0
|
|
while IFS= read -r f; do
|
|
[ -z "$f" ] && continue
|
|
n_total=$((n_total + 1))
|
|
# -S style: warnings + above (skip "info" and "style" noise).
|
|
out="$(shellcheck --severity=warning --shell=bash "$f" 2>&1)"
|
|
if [ -n "$out" ]; then
|
|
echo "── $f ──"
|
|
echo "$out"
|
|
echo
|
|
n_with_findings=$((n_with_findings + 1))
|
|
# rough count: one finding per "In <file> line N:" block
|
|
cnt=$(printf '%s' "$out" | grep -c "^In .* line")
|
|
total_findings=$((total_findings + cnt))
|
|
fi
|
|
done <<EOF
|
|
$FILES
|
|
EOF
|
|
|
|
echo "── Summary ──"
|
|
echo " scripts scanned: $n_total"
|
|
echo " scripts with issues: $n_with_findings"
|
|
echo " total findings: $total_findings"
|
|
|
|
if [ "$STRICT" -eq 1 ] && [ "$total_findings" -gt 0 ]; then
|
|
exit 1
|
|
fi
|
|
exit 0
|