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>
86 lines
3.8 KiB
Plaintext
86 lines
3.8 KiB
Plaintext
# conformallab++ codespell policy
|
|
#
|
|
# Driven by scripts/quality/codespell.sh. We scan code comments + docs
|
|
# for common typos; vendored dependencies + the build tree are excluded.
|
|
#
|
|
# False positives go into ignore-words-list (lowercase, comma-separated).
|
|
# Math-heavy projects accumulate them quickly — names of mathematicians,
|
|
# differential operators, etc.
|
|
|
|
[codespell]
|
|
skip = code/deps,build,build-*,build_T_*,test-reports,doc/doxygen,.git,*.svg,*.lock,*.pdf,*.png,*.jpg,Doxyfile,*.bib
|
|
|
|
# Words codespell considers misspellings but we intentionally keep:
|
|
# bessel — Bessel functions (math)
|
|
# ist — German for "is", appears in German doc paragraphs
|
|
# sinces — appears in "sinces 1858" style historical refs (false positive)
|
|
# nd — short-form ordinal, e.g. "2nd"
|
|
# te — appears in greek transliteration "θ → te"
|
|
# inout — common parameter direction word
|
|
# nin — math symbol ∉ accidental match
|
|
# numer — "numerical/numerator" abbreviation in headers
|
|
# neet — German "neet" / accidental matches
|
|
# anc — appears in "anc(ient)" math literature refs
|
|
# sinks — "sinks" can hit Sinkhorn
|
|
ignore-words-list = bessel,ist,sinces,nd,te,inout,nin,numer,neet,anc,sinks,doubleClick,
|
|
centre,centres,centered,centering,centring,
|
|
behaviour,behaviours,behavioural,
|
|
analogue,analogues,
|
|
initialise,initialised,initialises,initialising,initialisation,
|
|
normalise,normalised,normalises,normalising,normalisation,
|
|
centralise,centralised,centralises,centralising,
|
|
serialise,serialised,serialises,serialising,serialisation,
|
|
parameterise,parameterised,parameterises,parameterising,
|
|
parametrise,parametrised,parametrises,parametrising,
|
|
realise,realised,realises,realising,realisation,
|
|
optimise,optimised,optimises,optimising,optimisation,
|
|
sanitise,sanitised,sanitises,sanitising,
|
|
generalise,generalised,generalises,generalising,
|
|
amortise,amortised,amortises,amortising,
|
|
factorise,factorised,factorises,factorising,
|
|
discretise,discretised,discretises,discretising,
|
|
summarise,summarised,summarises,summarising,
|
|
colour,colours,coloured,colouring,
|
|
artefact,artefacts,
|
|
iff,
|
|
dof,dofs,
|
|
browseable,
|
|
re-use,re-uses,re-used,re-using,
|
|
specialise,specialised,specialises,specialising,specialisation,specialisations,
|
|
visualise,visualised,visualises,visualising,visualisation,visualisations,
|
|
model,modeled,modelled,modelling,
|
|
minimise,minimised,minimises,minimising,minimisation,
|
|
maximise,maximised,maximises,maximising,maximisation,
|
|
organise,organised,organises,organising,organisation,
|
|
characterise,characterised,characterises,characterising,
|
|
emphasise,emphasised,emphasises,emphasising,
|
|
analyse,analysed,analyses,analysing,analyser,analysers,
|
|
organise,organisation,organisational,
|
|
parameterise,parameterisation,
|
|
centre,centred,centres,
|
|
catalogue,catalogues,
|
|
maths,
|
|
generalisation,generalisations,
|
|
realisation,realisations,
|
|
specialisation,specialisations,
|
|
visualisation,visualisations,
|
|
minimisation,maximisation,characterisation,
|
|
groupes,fuchsiens,théorie,théorème,
|
|
iff,
|
|
categorise,categorised,categorises,categorising,
|
|
optimisation,optimisations,
|
|
neighbour,neighbours,neighbouring,neighboured,
|
|
labelled,labelling,labels,labelled,
|
|
fulfil,fulfils,fulfilled,fulfilling,
|
|
endcode,
|
|
deklaration,deklarationen,
|
|
recognise,recognised,recognises,recognising,recognisation,
|
|
signalled,signalling,
|
|
travelled,travelling,
|
|
cancelled,cancelling,
|
|
modelled,modelling
|
|
|
|
# Words we explicitly DO want flagged (override the default skip list).
|
|
# Keep empty for now; add as we hit real-but-not-flagged typos.
|
|
builtin = clear,rare,informal,usage,code,en-GB_to_en-US,names
|