Files
ConformalLabpp/.clang-tidy 2
Tarik Moussa 7b097fbdd1
Some checks failed
C++ Tests / test-fast (pull_request) Successful in 2m2s
API Docs / doc-build (pull_request) Successful in 46s
Markdown link check / check (pull_request) Successful in 47s
C++ Tests / test-cgal (pull_request) Failing after 10m51s
C++ Tests / quality-gates (pull_request) Successful in 2m21s
ci+licenses: promote 4 trivial gates to required CI + third-party license doc
Two reviewer-facing additions:

1. New `quality-gates` job in .gitea/workflows/cpp-tests.yml
   ──────────────────────────────────────────────────────────
   Runs in parallel with test-cgal after test-fast.  Installs
   `codespell` + `shellcheck` (apt) into the existing ci-cpp container,
   then executes four scripts strictly (exit 1 on any finding):
     * license-headers.sh   — 66/66 files carry SPDX MIT
     * cgal-conventions.py  — 0 violations across 6 CGAL public headers
     * codespell.sh         — 0 typos across docs + source + scripts
     * shellcheck.sh        — 0 findings across 16 shell scripts

   Each ran at 0 findings locally for weeks before promotion.  The
   gates are now contractual: a regression fails the PR.  Total
   wall-time on the eulernest runner: ~30 s.

2. New code/deps/THIRD-PARTY-LICENSES.md
   ──────────────────────────────────────
   Enumerates every vendored dependency under code/deps/, plus the
   auto-fetched GoogleTest, plus the system-required Boost, with:
     * upstream project + version + SPDX identifier
     * compatibility note for MIT distribution
     * a downstream-packager license matrix (header-only consumer
       vs CLI binary) clarifying the LGPL §3 vs §4 distinction
       relevant to CGAL's header-only consumption

   Required for any future Linux-distribution packaging and for the
   CGAL submission's compliance check.  Cross-referenced from
   doc/architecture/dependencies.md.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-24 20:06:58 +02:00

46 lines
1.7 KiB
Plaintext

# conformallab++ clang-tidy policy
#
# Curated, deliberately small. The CGAL header tree triggers tens of
# thousands of warnings under default settings (CGAL's chosen style is
# pre-C++17 in many places). Restricting to checks that fire on OUR
# code, not on transitive CGAL/Eigen/Boost headers, keeps the signal
# meaningful.
#
# Promotion gate: a check moves into this list only when (a) it fires
# on code we authored AND (b) the fix is mechanical (no algorithmic
# rewrite required). Anything algorithmic belongs in a code review,
# not in a static analyser.
Checks: >
-*,
bugprone-too-small-loop-variable,
bugprone-use-after-move,
bugprone-undefined-memory-manipulation,
bugprone-integer-division,
bugprone-suspicious-string-compare,
bugprone-misplaced-widening-cast,
bugprone-sizeof-expression,
cppcoreguidelines-init-variables,
cppcoreguidelines-pro-type-member-init,
performance-for-range-copy,
performance-implicit-conversion-in-loop,
performance-unnecessary-copy-initialization,
performance-unnecessary-value-param,
readability-misleading-indentation,
readability-redundant-smartptr-get,
modernize-use-nullptr,
modernize-use-override,
modernize-deprecated-headers
# Only emit warnings on our own headers. CGAL/Eigen/etc. live under
# `code/deps/` (vendored) or are installed system-wide; we never want
# clang-tidy fixes for them.
HeaderFilterRegex: '^.*/code/include/(?!deps/).*$'
WarningsAsErrors: ''
CheckOptions:
- { key: cppcoreguidelines-init-variables.IgnoreArrays, value: true }
- { key: performance-for-range-copy.WarnOnAllAutoCopies, value: true }
- { key: performance-unnecessary-value-param.AllowedTypes, value: 'Eigen::Vector.*;Eigen::Matrix.*' }