Files
ConformalLabpp/.clang-format 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

77 lines
2.5 KiB
Plaintext

# conformallab++ formatting policy
#
# Captures the style already present in code/include/. Documented here
# so clang-format can enforce it locally (scripts/quality/clang-format.sh)
# and so new contributors get the same output their editor would on save.
#
# This is NOT the upstream CGAL clang-format (there isn't one published);
# it's the style our tree already uses, mechanically extracted.
BasedOnStyle: LLVM
Language: Cpp
Standard: c++17
IndentWidth: 4
TabWidth: 4
UseTab: Never
ColumnLimit: 100 # loose; readability over hard wrap
# Brace placement — matches the project tree:
# functions / methods → opening brace on a new line (CGAL convention)
# structs / classes → opening brace on a new line
# else / catch → on the same line as the closing brace of the preceding block
BreakBeforeBraces: Custom
BraceWrapping:
AfterClass: true
AfterStruct: true
AfterEnum: true
AfterFunction: true
AfterNamespace: false
AfterUnion: true
AfterControlStatement: false
BeforeElse: false
BeforeCatch: false
IndentBraces: false
SplitEmptyFunction: false
SplitEmptyRecord: false
SplitEmptyNamespace: true
# Reference & pointer modifiers attach to the type (`int& x`, not `int &x`).
PointerAlignment: Left
ReferenceAlignment: Left
# Aligned `using = ...` blocks are intentional in the trait classes.
AlignConsecutiveDeclarations: AcrossEmptyLines
AlignConsecutiveAssignments: AcrossEmptyLines
AlignTrailingComments: true
AlignAfterOpenBracket: Align
AllowShortFunctionsOnASingleLine: Inline
AllowShortIfStatementsOnASingleLine: Never
AllowShortLoopsOnASingleLine: false
AllowShortBlocksOnASingleLine: Never
AllowShortLambdasOnASingleLine: Inline
# Template-related: break before each parameter when the template line
# would otherwise exceed ColumnLimit (matches existing
# `template <typename TriangleMesh, typename ...>` patterns).
BreakBeforeBinaryOperators: NonAssignment
BinPackParameters: false
BinPackArguments: false
AlwaysBreakTemplateDeclarations: Yes
SpaceAfterTemplateKeyword: true
NamespaceIndentation: None
AccessModifierOffset: -4
IndentCaseLabels: false
# Includes: keep manual ordering — re-ordering can break Eigen / CGAL
# transitive-include assumptions in subtle ways. We just enforce no
# accidental duplicate blank lines.
SortIncludes: Never
MaxEmptyLinesToKeep: 1
KeepEmptyLinesAtTheStartOfBlocks: false
# Comments: don't touch.
ReflowComments: false