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>
88 lines
2.1 KiB
Bash
Executable File
88 lines
2.1 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# scripts/quality/codespell.sh
|
|
#
|
|
# Run codespell across the repo to catch typos in:
|
|
# * doc/**/*.md (reviewer-facing material)
|
|
# * code/include/**/*.{h,hpp} (Doxygen comments are user-facing)
|
|
# * code/src/, code/tests/ (test names, error messages)
|
|
# * scripts/**/*.{sh,py} (CI messages reach contributors)
|
|
# * README.md, CHANGELOG.md, CLAUDE.md
|
|
#
|
|
# Skips vendored deps, build dirs, generated Doxygen output (see
|
|
# `.codespellrc`).
|
|
#
|
|
# Local-only. CI promotion once the existing tree is 0-typo.
|
|
#
|
|
# Usage:
|
|
# bash scripts/quality/codespell.sh # dry-run, exit 1 on any hit
|
|
# bash scripts/quality/codespell.sh --fix # interactively apply suggestions
|
|
#
|
|
# Exit codes:
|
|
# 0 no typos
|
|
# 1 at least one typo found (no --fix), or --fix completed
|
|
# 2 prerequisite missing
|
|
|
|
set -uo pipefail
|
|
ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
|
|
cd "$ROOT" || exit 2
|
|
|
|
command -v codespell >/dev/null 2>&1 || {
|
|
echo "FAIL: codespell not in PATH." >&2
|
|
echo " macOS: brew install codespell" >&2
|
|
echo " Linux: sudo apt install codespell OR pip3 install codespell" >&2
|
|
exit 2
|
|
}
|
|
|
|
FIX=0
|
|
for arg in "$@"; do
|
|
case "$arg" in
|
|
--fix) FIX=1 ;;
|
|
*) echo "Unknown arg: $arg" >&2; exit 2 ;;
|
|
esac
|
|
done
|
|
|
|
# Targets: everything except deps + build + generated.
|
|
TARGETS=(
|
|
"doc"
|
|
"code/include"
|
|
"code/src"
|
|
"code/tests"
|
|
"scripts"
|
|
"README.md"
|
|
"CHANGELOG.md"
|
|
"CLAUDE.md"
|
|
"CITATION.cff"
|
|
"CONTRIBUTING.md"
|
|
)
|
|
|
|
# Filter to existing entries (CONTRIBUTING.md / CHANGELOG.md may not exist
|
|
# on every branch).
|
|
EXISTING=()
|
|
for t in "${TARGETS[@]}"; do
|
|
[ -e "$t" ] && EXISTING+=("$t")
|
|
done
|
|
|
|
echo "codespell ($(codespell --version 2>&1 | head -1))"
|
|
echo "Targets: ${EXISTING[*]}"
|
|
echo
|
|
|
|
if [ "$FIX" -eq 1 ]; then
|
|
codespell --write-changes "${EXISTING[@]}"
|
|
rc=$?
|
|
else
|
|
codespell "${EXISTING[@]}"
|
|
rc=$?
|
|
fi
|
|
|
|
if [ "$rc" -ne 0 ]; then
|
|
echo
|
|
echo "Recovery:"
|
|
echo " bash scripts/quality/codespell.sh --fix # apply"
|
|
echo " # or add false-positives to .codespellrc → ignore-words-list"
|
|
exit 1
|
|
fi
|
|
|
|
echo
|
|
echo "OK: no typos found."
|
|
exit 0
|