Guardrails / cpp

C++ standard is required, not preferred

cpp/standard-required@v1

A CMake build that enables C++ requires the standard it declares, so a compiler that does not offer it fails rather than falling back to an older one.

Id	cpp/standard-required
Version	v1
Category	cpp
Default severity	warning
Interpreter	python3
Timeout	30 seconds
Violations tolerated	0
Collects	cpp

Collectors

This guardrail gathers nothing itself. It depends on the collectors below, which the CLI runs once per build before any check, and reads what they found out of GUARDRAIL_FACTS. A collector that collects nothing skips this guardrail rather than failing it.

Collector	Gathers	Inputs it is given
cpp	The C or C++ build in the project directory: which build system and package manager it uses, the C++ standard and CMake version it requires, the packages it declares and which of them are pinned, and the packages it expects the machine to carry. CMakeLists.txt is a script, so what it declares conditionally is not seen and scanned says so.	projectDir

The inputs above are this guardrail's own, passed straight through. Configuring one in buildnote.json changes what is collected, and two guardrails configured the same way share the one collection.

Configuration

{
  "guardrails": {
      "failOn": "error",
      "comment": true,
      "checks": [
          {
              "use": "cpp/standard-required@v1",
              "severity": "warning",
              "with": {
                  "projectDir": "."
              },
              "exemptions": []
          }
      ]
  }
}

Inputs

Input	Description	Default	Environment variable
projectDir	Directory holding the project, relative to the directory the CLI runs in.	.	GUARDRAIL_INPUT_PROJECTDIR

How to fix

Turn the standard into a requirement beside where it is declared:

set(CMAKE_CXX_STANDARD 20)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

With CMAKE_CXX_STANDARD_REQUIRED off CMake treats the standard as a preference: a compiler that does not offer it drops to an older one and configures without a word, so the build compiles differently on a different machine and the error arrives as a missing header rather than as a toolchain that is too old.

More in cpp

• cpp/cmake-minimum-floor. A CMake build names the CMake version whose policy defaults it configures under, and that version is no older than the configured floor.
• cpp/package-manager-declared. The checkout declares its dependencies through vcpkg or Conan, so it names the versions it builds against rather than taking whatever the machine carries.
• cpp/standard-declared. A CMake build that enables C++ declares the standard it compiles against, and that standard is no older than the configured floor.

All 4 cpp guardrails