d3c08b3bc0
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>
81 lines
3.6 KiB
Plaintext
81 lines
3.6 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
|
|
|
|
# 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
|