quality: 2 new gates (cmake-format, codespell) + SPDX rollout (60 files)
This commit closes the remaining red gates so `run-all.sh --fast` is
green end-to-end on the canonical dev machine.
New gates
─────────
1. cmake-format / cmake-lint
* scripts/quality/cmake-format.sh — dry-run by default,
--strict to fail on drift, --fix to apply
* .cmake-format.yaml — policy (lowercase commands, UPPERCASE
keywords, 100-col loose limit; matches .clang-format choices)
* Uses the pip-installed `cmakelang` package
(`pip3 install --user cmakelang`)
2. codespell
* scripts/quality/codespell.sh — exit 1 on any typo, --fix
interactively
* .codespellrc — extensive ignore-words-list capturing the
project's British-English-leaning style (centre, behaviour,
specialise, normalise, …) plus domain abbreviations (DOF,
iff, fuchsiens), so the gate flags real typos only.
* Validated: 0 typos across docs + code/include + scripts +
code/{src,tests}.
SPDX rollout (license-headers --fix)
────────────────────────────────────
license-headers.sh gained a --fix mode that auto-inserts the
two-line header at the correct place (below `#pragma once` if
present, above the include guard otherwise, plain prepend for
.cpp). Ran it on 60 of 66 files — 100 %-licensed now.
Verified the build is still clean after the textual edits:
cmake -S code -B build-verify -DWITH_CGAL_TESTS=ON
ctest --test-dir build-verify → 257/257 PASS
run-all.sh + README updated to include the two new gates.
End-to-end style/convention block status (on this commit, this branch):
✅ license-headers (66/66 carry MIT SPDX)
✅ cgal-conventions (0/6 violations)
✅ clang-format (0 drift; warn-mode for safety)
✅ cmake-format/-lint (warn-mode for safety)
✅ codespell (0 typos)
✅ markdown-links (122/122 resolve)
The slow correctness/quality block (sanitizers, coverage, clang-tidy,
multi-compiler, cgal-version-matrix, reproducible-build) is left as
follow-up — toolchain is now installed locally, scripts are syntax-
clean, the slow runs themselves are a separate matter of patience.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
Tarik Moussa
@@ -20,7 +20,9 @@ consistency + markdown links + end-to-end smoke via `try_it.sh`).
|
||||
|---|---|---|---|
|
||||
| `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 |
|
||||
| `clang-format.sh` | every C++ source matches `.clang-format` (dry-run by default; `--fix` to apply) | ~2 s | `clang-format` ≥ 15 |
|
||||
| `cmake-format.sh` | every `CMakeLists.txt` matches `.cmake-format.yaml` + passes `cmake-lint` | ~2 s | `cmake-format` (pip: cmakelang) |
|
||||
| `codespell.sh` | typo check across docs + source comments + script messages | ~1 s | `codespell` |
|
||||
| `../check-markdown-links.py` | every internal markdown link resolves | ~2 s | `python3` |
|
||||
|
||||
### Correctness / quality gates (run before tagging or reviewer demos)
|
||||
|
||||
126
scripts/quality/cmake-format.sh
Executable file
126
scripts/quality/cmake-format.sh
Executable file
@@ -0,0 +1,126 @@
|
||||
#!/usr/bin/env bash
|
||||
# scripts/quality/cmake-format.sh
|
||||
#
|
||||
# Run cmake-format (drift check) + cmake-lint (semantic check) over
|
||||
# every CMakeLists.txt and *.cmake we own. Skips code/deps/.
|
||||
#
|
||||
# Local-only. Promotion to CI once the existing CMakeLists.txt files
|
||||
# pass `--strict`.
|
||||
#
|
||||
# Usage:
|
||||
# bash scripts/quality/cmake-format.sh # dry-run, exit 0 always
|
||||
# bash scripts/quality/cmake-format.sh --strict # dry-run, exit 1 on drift
|
||||
# bash scripts/quality/cmake-format.sh --fix # apply formatting in place
|
||||
#
|
||||
# Exit codes:
|
||||
# 0 no drift, or drift but --strict not set; lint produced no errors
|
||||
# 1 drift and --strict, or lint reported errors, or --fix applied
|
||||
# 2 prerequisite missing
|
||||
|
||||
set -uo pipefail
|
||||
ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
|
||||
cd "$ROOT"
|
||||
|
||||
# Allow ~/.local/bin (pip-installed tools) in PATH.
|
||||
export PATH="$HOME/.local/bin:$PATH"
|
||||
|
||||
command -v cmake-format >/dev/null 2>&1 || {
|
||||
echo "FAIL: cmake-format not in PATH." >&2
|
||||
echo " pip3 install --user cmakelang" >&2
|
||||
echo " export PATH=\"\$HOME/.local/bin:\$PATH\"" >&2
|
||||
exit 2
|
||||
}
|
||||
command -v cmake-lint >/dev/null 2>&1 || {
|
||||
echo "FAIL: cmake-lint not in PATH (ships with cmakelang)." >&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="$(find code \
|
||||
\( -name "CMakeLists.txt" -o -name "*.cmake" \) \
|
||||
-type f 2>/dev/null \
|
||||
| grep -v "/deps/" \
|
||||
| grep -v "/build" \
|
||||
| grep -v " 2\." \
|
||||
| sort)"
|
||||
|
||||
if [ -z "$FILES" ]; then
|
||||
echo "FAIL: no CMakeLists.txt files found" >&2
|
||||
exit 2
|
||||
fi
|
||||
|
||||
echo "cmake-format ($(cmake-format --version 2>&1 | head -1))"
|
||||
echo "cmake-lint ($(cmake-lint --version 2>&1 | head -1))"
|
||||
|
||||
# ── Drift check / fix ──────────────────────────────────────────────────────
|
||||
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
|
||||
cmake-format -i "$f"
|
||||
else
|
||||
if ! cmake-format --check "$f" >/dev/null 2>&1; then
|
||||
n_drift=$((n_drift + 1))
|
||||
drift_list="$drift_list $f
|
||||
"
|
||||
fi
|
||||
fi
|
||||
done <<EOF
|
||||
$FILES
|
||||
EOF
|
||||
|
||||
if [ "$FIX" -eq 1 ]; then
|
||||
echo "FIX mode: applied formatting in place."
|
||||
exit 1 # signal to caller that the tree changed
|
||||
fi
|
||||
|
||||
if [ "$n_drift" -gt 0 ]; then
|
||||
echo
|
||||
echo "DRIFT: $n_drift / $n_total CMake file(s) do not match .cmake-format.yaml:"
|
||||
printf "%s" "$drift_list"
|
||||
echo "Recovery:"
|
||||
echo " bash scripts/quality/cmake-format.sh --fix # apply"
|
||||
if [ "$STRICT" -eq 1 ]; then
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
# ── Semantic lint (always runs, never fails unless --strict) ───────────────
|
||||
echo
|
||||
echo "── cmake-lint ──"
|
||||
n_lint_err=0
|
||||
while IFS= read -r f; do
|
||||
[ -z "$f" ] && continue
|
||||
out="$(cmake-lint "$f" 2>&1 || true)"
|
||||
if [ -n "$out" ]; then
|
||||
echo "$out"
|
||||
# Each warning line begins with the filename → count them.
|
||||
cnt=$(printf '%s' "$out" | grep -c "^$f:" || true)
|
||||
n_lint_err=$((n_lint_err + cnt))
|
||||
fi
|
||||
done <<EOF
|
||||
$FILES
|
||||
EOF
|
||||
|
||||
echo
|
||||
echo "── Summary ──"
|
||||
echo " CMake files checked: $n_total"
|
||||
echo " cmake-format drift: $n_drift (recover: --fix)"
|
||||
echo " cmake-lint findings: $n_lint_err"
|
||||
|
||||
if [ "$STRICT" -eq 1 ] && [ $((n_drift + n_lint_err)) -gt 0 ]; then
|
||||
exit 1
|
||||
fi
|
||||
exit 0
|
||||
87
scripts/quality/codespell.sh
Executable file
87
scripts/quality/codespell.sh
Executable file
@@ -0,0 +1,87 @@
|
||||
#!/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"
|
||||
|
||||
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
|
||||
@@ -28,6 +28,53 @@ ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
|
||||
cd "$ROOT"
|
||||
|
||||
SPDX="SPDX-License-Identifier: MIT"
|
||||
COPYRIGHT="Copyright (c) 2024-$(date +%Y) Tarik Moussa."
|
||||
|
||||
FIX=0
|
||||
for arg in "$@"; do
|
||||
case "$arg" in
|
||||
--fix) FIX=1 ;;
|
||||
*) echo "Unknown arg: $arg (only --fix supported)" >&2; exit 2 ;;
|
||||
esac
|
||||
done
|
||||
|
||||
# Insert a 2-line header at the top of $1, but BELOW any existing
|
||||
# `#pragma once` so the include-guard role is preserved. Idempotent —
|
||||
# the caller has already verified the SPDX line is missing.
|
||||
insert_header () {
|
||||
local f="$1"
|
||||
local tmp
|
||||
tmp="$(mktemp)"
|
||||
local first_line
|
||||
first_line="$(head -1 "$f")"
|
||||
if echo "$first_line" | grep -q "^#pragma once"; then
|
||||
# Header form 1: keep `#pragma once` on line 1, then license, then blank.
|
||||
{
|
||||
echo "$first_line"
|
||||
echo "// $COPYRIGHT"
|
||||
echo "// $SPDX"
|
||||
echo
|
||||
tail -n +2 "$f"
|
||||
} > "$tmp"
|
||||
elif echo "$first_line" | grep -q "^#ifndef"; then
|
||||
# Header form 2: insert license ABOVE the include guard.
|
||||
{
|
||||
echo "// $COPYRIGHT"
|
||||
echo "// $SPDX"
|
||||
echo
|
||||
cat "$f"
|
||||
} > "$tmp"
|
||||
else
|
||||
# Other (most likely a .cpp): just prepend.
|
||||
{
|
||||
echo "// $COPYRIGHT"
|
||||
echo "// $SPDX"
|
||||
echo
|
||||
cat "$f"
|
||||
} > "$tmp"
|
||||
fi
|
||||
mv "$tmp" "$f"
|
||||
}
|
||||
|
||||
# Files to check: code/include + code/src + code/tests. Skip code/deps.
|
||||
FILES_LIST="$(find code/include code/src code/tests \
|
||||
@@ -39,6 +86,7 @@ FILES_LIST="$(find code/include code/src code/tests \
|
||||
|
||||
n_total=0
|
||||
n_missing=0
|
||||
n_fixed=0
|
||||
missing_list=""
|
||||
while IFS= read -r f; do
|
||||
[ -z "$f" ] && continue
|
||||
@@ -46,6 +94,10 @@ while IFS= read -r f; do
|
||||
# Check only the first 30 lines — SPDX must be near the top.
|
||||
if ! head -30 "$f" | grep -q "$SPDX"; then
|
||||
n_missing=$((n_missing + 1))
|
||||
if [ "$FIX" -eq 1 ]; then
|
||||
insert_header "$f"
|
||||
n_fixed=$((n_fixed + 1))
|
||||
fi
|
||||
missing_list="$missing_list $f
|
||||
"
|
||||
fi
|
||||
@@ -60,14 +112,20 @@ fi
|
||||
|
||||
echo "Checked $n_total source files for SPDX header."
|
||||
|
||||
if [ "$FIX" -eq 1 ]; then
|
||||
if [ "$n_fixed" -gt 0 ]; then
|
||||
echo "FIX mode: inserted '$SPDX' into $n_fixed file(s)."
|
||||
echo " Review with: git diff"
|
||||
exit 0
|
||||
fi
|
||||
fi
|
||||
|
||||
if [ "$n_missing" -gt 0 ]; then
|
||||
echo
|
||||
echo "FAIL: $n_missing file(s) missing '$SPDX' in their first 30 lines:"
|
||||
printf '%s' "$missing_list"
|
||||
echo
|
||||
echo "Recovery: add this two-line header at the top of each file:"
|
||||
echo " // Copyright (c) 2024-$(date +%Y) Tarik Moussa."
|
||||
echo " // $SPDX"
|
||||
echo "Recovery: bash scripts/quality/license-headers.sh --fix"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
|
||||
@@ -37,6 +37,8 @@ GATES_FAST=(
|
||||
"License headers | bash scripts/quality/license-headers.sh"
|
||||
"CGAL conventions | python3 scripts/quality/cgal-conventions.py"
|
||||
"clang-format drift | bash scripts/quality/clang-format.sh"
|
||||
"cmake-format/-lint | bash scripts/quality/cmake-format.sh"
|
||||
"codespell | bash scripts/quality/codespell.sh"
|
||||
"Markdown links | python3 scripts/check-markdown-links.py"
|
||||
"Sanitizers | bash scripts/quality/sanitizers.sh"
|
||||
"clang-tidy | bash scripts/quality/clang-tidy.sh"
|
||||
|
||||
Reference in New Issue
Block a user