f1d77aa293
Closes the gap "no code-quality / convention gate" from the structural
review. Three new artefacts, all local-only (CI promotion deferred
until the existing tree is 100 % clean under each):
1. .clang-format — project's existing style mechanically captured
(4-space indent, opening brace on new line for class/struct/function,
left-aligned pointer/reference modifiers, aligned `using = ...` blocks,
100-col loose limit, no include re-ordering — matches code/include/
today).
2. scripts/quality/clang-format.sh — drift detector. Dry-run mode by
default (always exits 0); --strict to fail on drift; --fix to apply
suggested changes in place. Skips code/deps/ and macOS-duplicate
files.
3. scripts/quality/cgal-conventions.py — checker for the CGAL idioms
that clang-format/clang-tidy cannot express:
CGAL-1 include-guard format `CGAL_<DIRS>_<FILE>_H`
CGAL-2 every public header has a `\\file` Doxygen brief
CGAL-3 no nested namespaces beyond the allowed set
(CGAL::parameters, CGAL::Conformal_map, internal_np, IO)
CGAL-4 named-parameter tag types end in `_t`; value object does not
CGAL-5 no `using namespace ...` at file scope (header leakage)
CGAL-6 no #define beyond CGAL_* / include-guard
Result on the current tree: 6 CGAL public headers, 0 violations.
The checker therefore doubles as documentation of the conventions
we already follow.
Both are wired into scripts/quality/run-all.sh's fast subset (~5 s
combined wall time). README.md updated to split the gates into a
"style/convention" group (cheap, run-on-every-commit material) and a
"correctness/quality" group (slow, run-before-tag material).
The reviewer-facing locked-vs-flexible.md gains another "✅ Closed"
row documenting both gates and the 0-violation baseline.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Local structural quality gates
This directory contains the structural quality checks that run locally
rather than in CI. They are intentionally not wired into
.gitea/workflows/ (yet) because each is either too slow, too brittle
against the runner environment, or both — running them before a release
or before showing the repo to an external reviewer is the intended
workflow.
The CI gates that are enforced live in .gitea/workflows/cpp-tests.yml
and .gitea/workflows/doxygen-pages.yml; they cover the day-to-day
correctness loop (build + test + doxygen-coverage + test-count
consistency + markdown links + end-to-end smoke via try_it.sh).
What runs locally
Style / convention gates (run on every commit; cheap)
| Script | What it checks | Wall time | Prereqs |
|---|---|---|---|
license-headers.sh |
every C++ source carries SPDX-License-Identifier: MIT |
~1 s | bash |
cgal-conventions.py |
CGAL-1…6: include-guard format, \file brief, namespace nesting, tag-naming, no using namespace, no stray #define |
~1 s | python3 |
clang-format.sh |
every source file matches .clang-format (dry-run by default; --fix to apply) |
~2 s | clang-format ≥ 15 |
../check-markdown-links.py |
every internal markdown link resolves | ~2 s | python3 |
Correctness / quality gates (run before tagging or reviewer demos)
| Script | What it checks | Wall time | Prereqs |
|---|---|---|---|
sanitizers.sh |
fast test suite under ASan + UBSan | ~3 min | clang++ ≥ 14 or g++ ≥ 11 |
coverage.sh |
gcov/lcov line + branch coverage of code/include/ |
~2 min | lcov |
clang-tidy.sh |
curated clang-tidy checks over public headers | ~2 min | clang-tidy ≥ 14, .clang-tidy |
multi-compiler.sh |
build + test under every detected gcc/clang | ~5 min × N compilers | any 2 of g++, clang++ |
reproducible-build.sh |
two builds → byte-identical test executables | ~6 min | none beyond compiler |
cgal-version-matrix.sh |
build + CGAL test suite against multiple CGAL versions | ~5 min × N versions | CGAL trees under ~/cgal/<ver>/ (or CGAL_ROOTS=...) |
How to use
# Fast subset (license + links + sanitizers + clang-tidy) — ~5 min total
bash scripts/quality/run-all.sh --fast
# Full sweep — ~25–40 min, intended for pre-release tagging
bash scripts/quality/run-all.sh
# One specific gate
bash scripts/quality/sanitizers.sh
Every gate writes its full output to build-quality-logs/<gate>.log
when invoked via run-all.sh, and to its own per-gate build directory
(build-sanitizers/, build-coverage/, build-multi-<cc>/, …) when
invoked directly.
Promotion path to CI
Each gate can be wired into .gitea/workflows/cpp-tests.yml once two
conditions are met:
- The gate is green on the canonical dev machine. If the script exits 1 today, the CI gate would block every PR.
- There is a published policy line in
doc/release-policy.mdthat explains what regression the gate catches and what the recovery is. Future contributors should be able to read the error and know what to fix.
Promoting a gate is a one-line change to cpp-tests.yml; the test
recipe is the script invocation itself.
Known limitations
cgal-version-matrix.shdoes not download CGAL. Each version must already be on the dev machine under~/cgal/<ver>/(override withCGAL_ROOTS=...:...). The Dockerfile under.gitea/docker/Dockerfile.ci-cppcould be extended to ship multiple CGAL trees in a single image; not done yet.sanitizers.shonly instruments the fast (non-CGAL) test suite — the CGAL templates are too expensive to compile under instrumentation on most laptops.clang-tidy.shrequires a.clang-tidyconfig in the repo root; the default Anthropic-quality lint set is intentionally minimal until the reviewer signs off on the warning policy.reproducible-build.shchecks the test executables only. The library is header-only, so there is nothing else to compare.