CMake Presets

CMake Presets

Type object
File match CMakePresets.json CMakeUserPresets.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/cmake-presets/latest.json
Source https://raw.githubusercontent.com/Kitware/CMake/master/Help/manual/presets/schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

One of

1. object object

The presets specify the generator and the build directory, and optionally an array of variables and other arguments to pass to CMake.

version integer required

A required integer representing the version of the JSON schema.

Constant: 1
cmakeMinimumRequired object

An optional object representing the minimum version of CMake needed to build this project.

3 nested properties
major integer

An optional integer representing the major version.

minor integer

An optional integer representing the minor version.

patch integer

An optional integer representing the patch version.

vendor object

An optional map containing vendor-specific information. CMake does not interpret the contents of this field except to verify that it is a map if it does exist. However, the keys should be a vendor-specific domain name followed by a /-separated path. For example, the Example IDE 1.0 could use example.com/ExampleIDE/1.0. The value of each field can be anything desired by the vendor, though will typically be a map.

configurePresets object[]

An optional array of configure preset objects.

2. object object

The presets specify the generator and the build directory, and optionally an array of variables and other arguments to pass to CMake.

version integer required

A required integer representing the version of the JSON schema.

Constant: 2
cmakeMinimumRequired object

An optional object representing the minimum version of CMake needed to build this project.

3 nested properties
major integer

An optional integer representing the major version.

minor integer

An optional integer representing the minor version.

patch integer

An optional integer representing the patch version.

vendor object

An optional map containing vendor-specific information. CMake does not interpret the contents of this field except to verify that it is a map if it does exist. However, the keys should be a vendor-specific domain name followed by a /-separated path. For example, the Example IDE 1.0 could use example.com/ExampleIDE/1.0. The value of each field can be anything desired by the vendor, though will typically be a map.

configurePresets object[]

An optional array of configure preset objects.

buildPresets object[]

An optional array of build preset objects.

testPresets object[]

An optional array of test preset objects. Used to specify arguments to ctest.

3. object object

The presets specify the generator and the build directory, and optionally an array of variables and other arguments to pass to CMake.

version integer required

A required integer representing the version of the JSON schema.

Constant: 3
cmakeMinimumRequired object

An optional object representing the minimum version of CMake needed to build this project.

3 nested properties
major integer

An optional integer representing the major version.

minor integer

An optional integer representing the minor version.

patch integer

An optional integer representing the patch version.

vendor object

An optional map containing vendor-specific information. CMake does not interpret the contents of this field except to verify that it is a map if it does exist. However, the keys should be a vendor-specific domain name followed by a /-separated path. For example, the Example IDE 1.0 could use example.com/ExampleIDE/1.0. The value of each field can be anything desired by the vendor, though will typically be a map.

configurePresets object[]

An optional array of configure preset objects.

buildPresets object[]

An optional array of build preset objects.

testPresets object[]

An optional array of test preset objects. Used to specify arguments to ctest.

4. object object

The presets specify the generator and the build directory, and optionally an array of variables and other arguments to pass to CMake.

version integer required

A required integer representing the version of the JSON schema.

Constant: 4
cmakeMinimumRequired object

An optional object representing the minimum version of CMake needed to build this project.

3 nested properties
major integer

An optional integer representing the major version.

minor integer

An optional integer representing the minor version.

patch integer

An optional integer representing the patch version.

include string[]

An optional array of strings representing files to include. If the filenames are not absolute, they are considered relative to the current file.

vendor object

An optional map containing vendor-specific information. CMake does not interpret the contents of this field except to verify that it is a map if it does exist. However, the keys should be a vendor-specific domain name followed by a /-separated path. For example, the Example IDE 1.0 could use example.com/ExampleIDE/1.0. The value of each field can be anything desired by the vendor, though will typically be a map.

configurePresets object[]

An optional array of configure preset objects.

buildPresets object[]

An optional array of build preset objects.

testPresets object[]

An optional array of test preset objects. Used to specify arguments to ctest.

5. object object

The presets specify the generator and the build directory, and optionally an array of variables and other arguments to pass to CMake.

version integer required

A required integer representing the version of the JSON schema.

Constant: 5
cmakeMinimumRequired object

An optional object representing the minimum version of CMake needed to build this project.

3 nested properties
major integer

An optional integer representing the major version.

minor integer

An optional integer representing the minor version.

patch integer

An optional integer representing the patch version.

include string[]

An optional array of strings representing files to include. If the filenames are not absolute, they are considered relative to the current file.

vendor object

An optional map containing vendor-specific information. CMake does not interpret the contents of this field except to verify that it is a map if it does exist. However, the keys should be a vendor-specific domain name followed by a /-separated path. For example, the Example IDE 1.0 could use example.com/ExampleIDE/1.0. The value of each field can be anything desired by the vendor, though will typically be a map.

configurePresets object[]

An optional array of configure preset objects.

buildPresets object[]

An optional array of build preset objects.

testPresets object[]

An optional array of test preset objects. Used to specify arguments to ctest.

6. object object

The presets specify the generator and the build directory, and optionally an array of variables and other arguments to pass to CMake.

version integer required

A required integer representing the version of the JSON schema.

Constant: 6
cmakeMinimumRequired object

An optional object representing the minimum version of CMake needed to build this project.

3 nested properties
major integer

An optional integer representing the major version.

minor integer

An optional integer representing the minor version.

patch integer

An optional integer representing the patch version.

include string[]

An optional array of strings representing files to include. If the filenames are not absolute, they are considered relative to the current file.

vendor object

An optional map containing vendor-specific information. CMake does not interpret the contents of this field except to verify that it is a map if it does exist. However, the keys should be a vendor-specific domain name followed by a /-separated path. For example, the Example IDE 1.0 could use example.com/ExampleIDE/1.0. The value of each field can be anything desired by the vendor, though will typically be a map.

configurePresets object[]

An optional array of configure preset objects.

buildPresets object[]

An optional array of build preset objects.

testPresets object[]

An optional array of test preset objects. Used to specify arguments to ctest.

packagePresets object[]

An optional array of package preset objects. Used to specify arguments to cpack.

workflowPresets object[]

An optional array of workflow preset objects. Used to execute configure, build, test, and package presets in order.

7. object object

The presets specify the generator and the build directory, and optionally an array of variables and other arguments to pass to CMake.

version integer required

A required integer representing the version of the JSON schema.

Constant: 7
cmakeMinimumRequired object

An optional object representing the minimum version of CMake needed to build this project.

3 nested properties
major integer

An optional integer representing the major version.

minor integer

An optional integer representing the minor version.

patch integer

An optional integer representing the patch version.

include string[]

An optional array of strings representing files to include. If the filenames are not absolute, they are considered relative to the current file.

vendor object

An optional map containing vendor-specific information. CMake does not interpret the contents of this field except to verify that it is a map if it does exist. However, the keys should be a vendor-specific domain name followed by a /-separated path. For example, the Example IDE 1.0 could use example.com/ExampleIDE/1.0. The value of each field can be anything desired by the vendor, though will typically be a map.

configurePresets object[]

An optional array of configure preset objects.

buildPresets object[]

An optional array of build preset objects.

testPresets object[]

An optional array of test preset objects. Used to specify arguments to ctest.

packagePresets object[]

An optional array of package preset objects. Used to specify arguments to cpack.

workflowPresets object[]

An optional array of workflow preset objects. Used to execute configure, build, test, and package presets in order.

8. object object

The presets specify the generator and the build directory, and optionally an array of variables and other arguments to pass to CMake.

version integer required

A required integer representing the version of the JSON schema.

Constant: 8
$schema string

An optional string that provides a URI to the JSON schema that describes the structure of this JSON document. This field is used for validation and autocompletion in editors that support JSON schema. It doesn't affect the behavior of the document itself. If this field is not specified, the JSON document will still be valid, but tools that use JSON schema for validation and autocompletion may not function correctly.

format=uri-reference
cmakeMinimumRequired object

An optional object representing the minimum version of CMake needed to build this project.

3 nested properties
major integer

An optional integer representing the major version.

minor integer

An optional integer representing the minor version.

patch integer

An optional integer representing the patch version.

include string[]

An optional array of strings representing files to include. If the filenames are not absolute, they are considered relative to the current file.

vendor object

An optional map containing vendor-specific information. CMake does not interpret the contents of this field except to verify that it is a map if it does exist. However, the keys should be a vendor-specific domain name followed by a /-separated path. For example, the Example IDE 1.0 could use example.com/ExampleIDE/1.0. The value of each field can be anything desired by the vendor, though will typically be a map.

configurePresets object[]

An optional array of configure preset objects.

buildPresets object[]

An optional array of build preset objects.

testPresets object[]

An optional array of test preset objects. Used to specify arguments to ctest.

packagePresets object[]

An optional array of package preset objects. Used to specify arguments to cpack.

workflowPresets object[]

An optional array of workflow preset objects. Used to execute configure, build, test, and package presets in order.

9. object object

The presets specify the generator and the build directory, and optionally an array of variables and other arguments to pass to CMake.

version integer required

A required integer representing the version of the JSON schema.

Constant: 9
$schema string

An optional string that provides a URI to the JSON schema that describes the structure of this JSON document. This field is used for validation and autocompletion in editors that support JSON schema. It doesn't affect the behavior of the document itself. If this field is not specified, the JSON document will still be valid, but tools that use JSON schema for validation and autocompletion may not function correctly.

format=uri-reference
cmakeMinimumRequired object

An optional object representing the minimum version of CMake needed to build this project.

3 nested properties
major integer

An optional integer representing the major version.

minor integer

An optional integer representing the minor version.

patch integer

An optional integer representing the patch version.

include string[]

An optional array of strings representing files to include. If the filenames are not absolute, they are considered relative to the current file.

vendor object

An optional map containing vendor-specific information. CMake does not interpret the contents of this field except to verify that it is a map if it does exist. However, the keys should be a vendor-specific domain name followed by a /-separated path. For example, the Example IDE 1.0 could use example.com/ExampleIDE/1.0. The value of each field can be anything desired by the vendor, though will typically be a map.

configurePresets object[]

An optional array of configure preset objects.

buildPresets object[]

An optional array of build preset objects.

testPresets object[]

An optional array of test preset objects. Used to specify arguments to ctest.

packagePresets object[]

An optional array of package preset objects. Used to specify arguments to cpack.

workflowPresets object[]

An optional array of workflow preset objects. Used to execute configure, build, test, and package presets in order.

10. object object

The presets specify the generator and the build directory, and optionally an array of variables and other arguments to pass to CMake.

version integer required

A required integer representing the version of the JSON schema.

Constant: 10
$schema string

An optional string that provides a URI to the JSON schema that describes the structure of this JSON document. This field is used for validation and autocompletion in editors that support JSON schema. It doesn't affect the behavior of the document itself. If this field is not specified, the JSON document will still be valid, but tools that use JSON schema for validation and autocompletion may not function correctly.

format=uri-reference
cmakeMinimumRequired object

An optional object representing the minimum version of CMake needed to build this project.

4 nested properties
major integer

An optional integer representing the major version.

minor integer

An optional integer representing the minor version.

patch integer

An optional integer representing the patch version.

$comment comment@v10..
include string[]

An optional array of strings representing files to include. If the filenames are not absolute, they are considered relative to the current file.

vendor object

An optional map containing vendor-specific information. CMake does not interpret the contents of this field except to verify that it is a map if it does exist. However, the keys should be a vendor-specific domain name followed by a /-separated path. For example, the Example IDE 1.0 could use example.com/ExampleIDE/1.0. The value of each field can be anything desired by the vendor, though will typically be a map.

configurePresets object[]

An optional array of configure preset objects.

buildPresets object[]

An optional array of build preset objects.

testPresets object[]

An optional array of test preset objects. Used to specify arguments to ctest.

packagePresets object[]

An optional array of package preset objects. Used to specify arguments to cpack.

workflowPresets object[]

An optional array of workflow preset objects. Used to execute configure, build, test, and package presets in order.

$comment comment@v10..
11. object object

The presets specify the generator and the build directory, and optionally an array of variables and other arguments to pass to CMake.

version integer required

A required integer representing the version of the JSON schema.

Constant: 11
$schema string

An optional string that provides a URI to the JSON schema that describes the structure of this JSON document. This field is used for validation and autocompletion in editors that support JSON schema. It doesn't affect the behavior of the document itself. If this field is not specified, the JSON document will still be valid, but tools that use JSON schema for validation and autocompletion may not function correctly.

format=uri-reference
cmakeMinimumRequired object

An optional object representing the minimum version of CMake needed to build this project.

4 nested properties
major integer

An optional integer representing the major version.

minor integer

An optional integer representing the minor version.

patch integer

An optional integer representing the patch version.

$comment comment@v10..
include string[]

An optional array of strings representing files to include. If the filenames are not absolute, they are considered relative to the current file.

vendor object

An optional map containing vendor-specific information. CMake does not interpret the contents of this field except to verify that it is a map if it does exist. However, the keys should be a vendor-specific domain name followed by a /-separated path. For example, the Example IDE 1.0 could use example.com/ExampleIDE/1.0. The value of each field can be anything desired by the vendor, though will typically be a map.

configurePresets object[]

An optional array of configure preset objects.

buildPresets object[]

An optional array of build preset objects.

testPresets object[]

An optional array of test preset objects. Used to specify arguments to ctest.

packagePresets object[]

An optional array of package preset objects. Used to specify arguments to cpack.

workflowPresets object[]

An optional array of workflow preset objects. Used to execute configure, build, test, and package presets in order.

$comment comment@v10..
12. object object

The presets specify the generator and the build directory, and optionally an array of variables and other arguments to pass to CMake.

version integer required

A required integer representing the version of the JSON schema.

Constant: 12
$schema string

An optional string that provides a URI to the JSON schema that describes the structure of this JSON document. This field is used for validation and autocompletion in editors that support JSON schema. It doesn't affect the behavior of the document itself. If this field is not specified, the JSON document will still be valid, but tools that use JSON schema for validation and autocompletion may not function correctly.

format=uri-reference
cmakeMinimumRequired object

An optional object representing the minimum version of CMake needed to build this project.

4 nested properties
major integer

An optional integer representing the major version.

minor integer

An optional integer representing the minor version.

patch integer

An optional integer representing the patch version.

$comment comment@v10..
include string[]

An optional array of strings representing files to include. If the filenames are not absolute, they are considered relative to the current file.

vendor object

An optional map containing vendor-specific information. CMake does not interpret the contents of this field except to verify that it is a map if it does exist. However, the keys should be a vendor-specific domain name followed by a /-separated path. For example, the Example IDE 1.0 could use example.com/ExampleIDE/1.0. The value of each field can be anything desired by the vendor, though will typically be a map.

configurePresets object[]

An optional array of configure preset objects.

buildPresets object[]

An optional array of build preset objects.

testPresets object[]

An optional array of test preset objects. Used to specify arguments to ctest.

packagePresets object[]

An optional array of package preset objects. Used to specify arguments to cpack.

workflowPresets object[]

An optional array of workflow preset objects. Used to execute configure, build, test, and package presets in order.

$comment comment@v10..

Definitions

$schema@v8.. string

An optional string that provides a URI to the JSON schema that describes the structure of this JSON document. This field is used for validation and autocompletion in editors that support JSON schema. It doesn't affect the behavior of the document itself. If this field is not specified, the JSON document will still be valid, but tools that use JSON schema for validation and autocompletion may not function correctly.

[email protected] object

An optional object representing the minimum version of CMake needed to build this project.

major integer

An optional integer representing the major version.

minor integer

An optional integer representing the minor version.

patch integer

An optional integer representing the patch version.

cmakeMinimumRequired@v10.. object

An optional object representing the minimum version of CMake needed to build this project.

major integer

An optional integer representing the major version.

minor integer

An optional integer representing the minor version.

patch integer

An optional integer representing the patch version.

$comment comment@v10..
cmakeMinimumRequired.major@v1.. integer

An optional integer representing the major version.

cmakeMinimumRequired.minor@v1.. integer

An optional integer representing the minor version.

cmakeMinimumRequired.patch@v1.. integer

An optional integer representing the patch version.

$comment@v10.. string | string[]
comment@v10.. string | string[]
include@v4.. string[]

An optional array of strings representing files to include. If the filenames are not absolute, they are considered relative to the current file.

vendor@v1.. object

An optional map containing vendor-specific information. CMake does not interpret the contents of this field except to verify that it is a map if it does exist. However, the keys should be a vendor-specific domain name followed by a /-separated path. For example, the Example IDE 1.0 could use example.com/ExampleIDE/1.0. The value of each field can be anything desired by the vendor, though will typically be a map.

[email protected] object[]

An optional array of configure preset objects.

[email protected] object[]

An optional array of configure preset objects.

[email protected] object[]

An optional array of configure preset objects.

[email protected] object[]

An optional array of configure preset objects.

configurePresets@v12 object[]

An optional array of configure preset objects.

configurePresets.name@v1.. string

A required string representing the machine-friendly name of the preset. This identifier is used in the cmake --preset option. There must not be two configure presets in the union of CMakePresets.json and CMakeUserPresets.json in the same directory with the same name. However, a configure preset may have the same name as a build, test, package, or workflow preset.

configurePresets.hidden@v1.. boolean

An optional boolean specifying whether or not a preset should be hidden. If a preset is hidden, it cannot be used in the --preset= argument, will not show up in the CMake GUI, and does not have to have a valid generator or binaryDir, even from inheritance. Hidden presets are intended to be used as a base for other presets to inherit via the inherits field.

configurePresets.inherits@v1.. string | string[]
configurePresets.condition@v10.. condition@v10.. | null
configurePresets.vendor@v1.. object

An optional map containing vendor-specific information. CMake does not interpret the contents of this field except to verify that it is a map if it does exist. However, it should follow the same conventions as the root-level vendor field.

configurePresets.displayName@v1.. string

An optional string with a human-friendly name of the preset.

configurePresets.description@v1.. string

An optional string with a human-friendly description of the preset.

[email protected] string

An optional string representing the generator to use for the preset. If generator is not specified, it must be inherited from the inherits preset (unless this preset is hidden). Note that for Visual Studio generators, unlike in the command line -G argument, you cannot include the platform name in the generator name. Use the architecture field instead.

configurePresets.generator@v3.. string

An optional string representing the generator to use for the preset. If generator is not specified, the normal generator discovery procedure is used. Note that for Visual Studio generators, unlike in the command line -G argument, you cannot include the platform name in the generator name. Use the architecture field instead.

[email protected] string | object
configurePresets.architecture@v10.. string | object
configurePresets.architecture.value@v1.. string

An optional string representing the value.

configurePresets.architecture.strategy@v1.. string

An optional string telling CMake how to handle the field. Valid values are: "set" Set the respective value. This will result in an error for generators that do not support the respective field. "external" Do not set the value, even if the generator supports it. This is useful if, for example, a preset uses the Ninja generator, and an IDE knows how to set up the Visual C++ environment from the architecture and toolset fields. In that case, CMake will ignore the field, but the IDE can use them to set up the environment before invoking CMake.

[email protected] string | object
configurePresets.toolset@v10.. string | object
configurePresets.toolset.value@v1.. string

An optional string representing the value.

configurePresets.toolset.strategy@v1.. string

An optional string telling CMake how to handle the field. Valid values are: "set" Set the respective value. This will result in an error for generators that do not support the respective field. "external" Do not set the value, even if the generator supports it. This is useful if, for example, a preset uses the Ninja generator, and an IDE knows how to set up the Visual C++ environment from the architecture and toolset fields. In that case, CMake will ignore the field, but the IDE can use them to set up the environment before invoking CMake.

configurePresets.toolchainFile@v3.. string

An optional string representing the path to the toolchain file. This field supports macro expansion. If a relative path is specified, it is calculated relative to the build directory, and if not found, relative to the source directory.

configurePresets.graphviz@v10.. string

An optional string specifying the path to the graphviz dot file.

[email protected] string

An optional string representing the path to the output binary directory. This field supports macro expansion. If a relative path is specified, it is calculated relative to the source directory. If binaryDir is not specified, it must be inherited from the inherits preset (unless this preset is hidden).

configurePresets.binaryDir@v3.. string

An optional string representing the path to the output binary directory. This field supports macro expansion. If a relative path is specified, it is calculated relative to the source directory. If binaryDir is not specified, the path is calculated using regular methods.

configurePresets.installDir@v3.. string

An optional string representing the path to the installation directory, which will be used as the CMAKE_INSTALL_PREFIX variable. This field supports macro expansion. If a relative path is specified, it is calculated relative to the source directory.

configurePresets.cmakeExecutable@v1.. string

An optional string representing the path to the CMake executable to use for this preset. This is reserved for use by IDEs, and is not used by CMake itself. IDEs that use this field should expand any macros in it.

[email protected] Record<string, null | boolean | string | object>

An optional map of cache variables. The key is the variable name (which must not be an empty string). Cache variables are inherited through the inherits field, and the preset's variables will be the union of its own cacheVariables and the cacheVariables from all its parents. If multiple presets in this union define the same variable, the standard rules of inherits are applied.

configurePresets.cacheVariables@v10.. Record<string, null | boolean | string | object>

An optional map of cache variables. The key is the variable name (which must not be an empty string). Cache variables are inherited through the inherits field, and the preset's variables will be the union of its own cacheVariables and the cacheVariables from all its parents. If multiple presets in this union define the same variable, the standard rules of inherits are applied.

configurePresets.cacheVariables.type@v1.. string

An optional string representing the type of the variable. It should be BOOL, FILEPATH, PATH, STRING, or INTERNAL.

configurePresets.cacheVariables.value@v1.. boolean | string
configurePresets.environment@v1.. Record<string, null | string>

An optional map of environment variables. The key is the variable name (which must not be an empty string). Each variable is set regardless of whether or not a value was given to it by the process's environment. This field supports macro expansion, and environment variables in this map may reference each other, and may be listed in any order, as long as such references do not cause a cycle (for example,if ENV_1 is $env{ENV_2}, ENV_2 may not be $env{ENV_1}.) Environment variables are inherited through the inherits field, and the preset's environment will be the union of its own environment and the environment from all its parents. If multiple presets in this union define the same variable, the standard rules of inherits are applied. Setting a variable to null causes it to not be set, even if a value was inherited from another preset.

[email protected] object

An optional object specifying the warnings to enable.

deprecated boolean

An optional boolean. Equivalent to passing -Wdeprecated or -Wno-deprecated on the command line. This may not be set to false if errors.deprecated is set to true.

dev boolean

An optional boolean. Equivalent to passing -Wdev or -Wno-dev on the command line. This may not be set to false if errors.dev is set to true.

uninitialized boolean

An optional boolean. Equivalent to passing -Wuninitialized or -Wno-uninitialized on the command line. This may not be set to false if errors.uninitialized is set to true.

unusedCli boolean

An optional boolean. Equivalent to passing -Wunused-cli or -Wno-unused-cli on the command line. This may not be set to false if errors.unusedCli is set to true.

systemVars boolean

An optional boolean. Setting this to true is equivalent to passing --check-system-vars on the command line.

[email protected] object

An optional object specifying the warnings to enable.

deprecated boolean

An optional boolean. Equivalent to passing -Wdeprecated or -Wno-deprecated on the command line. This may not be set to false if errors.deprecated is set to true.

dev boolean

An optional boolean. Equivalent to passing -Wdev or -Wno-dev on the command line. This may not be set to false if errors.dev is set to true.

uninitialized boolean

An optional boolean. Equivalent to passing -Wuninitialized or -Wno-uninitialized on the command line. This may not be set to false if errors.uninitialized is set to true.

unusedCli boolean

An optional boolean. Equivalent to passing -Wunused-cli or -Wno-unused-cli on the command line. This may not be set to false if errors.unusedCli is set to true.

systemVars boolean

An optional boolean. Setting this to true is equivalent to passing --check-system-vars on the command line.

$comment comment@v10..
configurePresets.warnings@v12 object

An optional object specifying the warnings to enable.

author boolean

An optional boolean. Equivalent to passing -Wauthor or -Wno-author on the command line. This may not be set to false if errors.author is set to true.

deprecated boolean

An optional boolean. Equivalent to passing -Wdeprecated or -Wno-deprecated on the command line. This may not be set to false if errors.deprecated is set to true.

installAbsoluteDestination boolean

An optional boolean. Equivalent to passing -Winstall-absolute-destination or -Wno-install-absolute-destination on the command line. This may not be set to false if errors.installAbsoluteDestination is set to true.

uninitialized boolean

An optional boolean. Equivalent to passing -Wuninitialized or -Wno-uninitialized on the command line. This may not be set to false if errors.uninitialized is set to true.

unusedCli boolean

An optional boolean. Equivalent to passing -Wunused-cli or -Wno-unused-cli on the command line. This may not be set to false if errors.unusedCli is set to true.

systemVars boolean

An optional boolean. Setting this to true is equivalent to passing --check-system-vars on the command line.

$comment comment@v10..
configurePresets.warnings.author@v12 boolean

An optional boolean. Equivalent to passing -Wauthor or -Wno-author on the command line. This may not be set to false if errors.author is set to true.

configurePresets.warnings.deprecated@v1.. boolean

An optional boolean. Equivalent to passing -Wdeprecated or -Wno-deprecated on the command line. This may not be set to false if errors.deprecated is set to true.

[email protected] boolean

An optional boolean. Equivalent to passing -Wdev or -Wno-dev on the command line. This may not be set to false if errors.dev is set to true.

configurePresets.warnings.installAbsoluteDestination@v12 boolean

An optional boolean. Equivalent to passing -Winstall-absolute-destination or -Wno-install-absolute-destination on the command line. This may not be set to false if errors.installAbsoluteDestination is set to true.

configurePresets.warnings.uninitialized@v1.. boolean

An optional boolean. Equivalent to passing -Wuninitialized or -Wno-uninitialized on the command line. This may not be set to false if errors.uninitialized is set to true.

configurePresets.warnings.unusedCli@v1.. boolean

An optional boolean. Equivalent to passing -Wunused-cli or -Wno-unused-cli on the command line. This may not be set to false if errors.unusedCli is set to true.

configurePresets.warnings.systemVars@v1.. boolean

An optional boolean. Setting this to true is equivalent to passing --check-system-vars on the command line.

[email protected] object

An optional object specifying the errors to enable.

deprecated boolean

An optional boolean. Equivalent to passing -Werror=deprecated or -Wno-error=deprecated on the command line. This may not be set to true if warnings.deprecated is set to false.

dev boolean

An optional boolean. Equivalent to passing -Werror=dev or -Wno-error=dev on the command line. This may not be set to true if warnings.dev is set to false.

[email protected] object

An optional object specifying the errors to enable.

deprecated boolean

An optional boolean. Equivalent to passing -Werror=deprecated or -Wno-error=deprecated on the command line. This may not be set to true if warnings.deprecated is set to false.

dev boolean

An optional boolean. Equivalent to passing -Werror=dev or -Wno-error=dev on the command line. This may not be set to true if warnings.dev is set to false.

$comment comment@v10..
configurePresets.errors@v12 object

An optional object specifying the errors to enable.

author boolean

An optional boolean. Equivalent to passing -Werror=author or -Wno-error=author on the command line. This may not be set to true if warnings.author is set to false.

deprecated boolean

An optional boolean. Equivalent to passing -Werror=deprecated or -Wno-error=deprecated on the command line. This may not be set to true if warnings.deprecated is set to false.

installAbsoluteDestination boolean

An optional boolean. Equivalent to passing -Werror=install-absolute-destination or -Wno-error=install-absolute-destination on the command line. This may not be set to true if warnings.installAbsoluteDestination is set to false.

uninitialized boolean

An optional boolean. Equivalent to passing -Werror=uninitialized or -Wno-error=uninitialized on the command line. This may not be set to true if warnings.uninitialized is set to false.

unusedCli boolean

An optional boolean. Equivalent to passing -Werror=unused-cli or -Wno-error=unused-cli on the command line. This may not be set to true if warnings.unusedCli is set to false.

$comment comment@v10..
configurePresets.errors.author@v12 boolean

An optional boolean. Equivalent to passing -Werror=author or -Wno-error=author on the command line. This may not be set to true if warnings.author is set to false.

configurePresets.errors.deprecated@v1.. boolean

An optional boolean. Equivalent to passing -Werror=deprecated or -Wno-error=deprecated on the command line. This may not be set to true if warnings.deprecated is set to false.

[email protected] boolean

An optional boolean. Equivalent to passing -Werror=dev or -Wno-error=dev on the command line. This may not be set to true if warnings.dev is set to false.

configurePresets.errors.installAbsoluteDestination@v12 boolean

An optional boolean. Equivalent to passing -Werror=install-absolute-destination or -Wno-error=install-absolute-destination on the command line. This may not be set to true if warnings.installAbsoluteDestination is set to false.

configurePresets.errors.uninitialized@v12 boolean

An optional boolean. Equivalent to passing -Werror=uninitialized or -Wno-error=uninitialized on the command line. This may not be set to true if warnings.uninitialized is set to false.

configurePresets.errors.unusedCli@v12 boolean

An optional boolean. Equivalent to passing -Werror=unused-cli or -Wno-error=unused-cli on the command line. This may not be set to true if warnings.unusedCli is set to false.

[email protected] object

An optional object specifying debug options.

output boolean

An optional boolean. Setting this to true is equivalent to passing --debug-output on the command line.

tryCompile boolean

An optional boolean. Setting this to true is equivalent to passing --debug-trycompile on the command line.

find boolean

An optional boolean. Setting this to true is equivalent to passing --debug-find on the command line.

configurePresets.debug@v10.. object

An optional object specifying debug options.

output boolean

An optional boolean. Setting this to true is equivalent to passing --debug-output on the command line.

tryCompile boolean

An optional boolean. Setting this to true is equivalent to passing --debug-trycompile on the command line.

find boolean

An optional boolean. Setting this to true is equivalent to passing --debug-find on the command line.

$comment comment@v10..
configurePresets.debug.output@v1.. boolean

An optional boolean. Setting this to true is equivalent to passing --debug-output on the command line.

configurePresets.debug.tryCompile@v1.. boolean

An optional boolean. Setting this to true is equivalent to passing --debug-trycompile on the command line.

configurePresets.debug.find@v1.. boolean

An optional boolean. Setting this to true is equivalent to passing --debug-find on the command line.

[email protected] object

An optional object specifying trace options.

mode string

An optional string that specifies the trace mode.

Values: "on" "off" "expand"
format string

An optional string that specifies the trace output format.

Values: "human" "json-v1"
source string | string[]
redirect string

An optional string specifying a path to a trace output file.

configurePresets.trace@v10.. object

An optional object specifying trace options.

mode string

An optional string that specifies the trace mode.

Values: "on" "off" "expand"
format string

An optional string that specifies the trace output format.

Values: "human" "json-v1"
source string | string[]
redirect string

An optional string specifying a path to a trace output file.

$comment comment@v10..
configurePresets.trace.mode@v7.. string

An optional string that specifies the trace mode.

configurePresets.trace.format@v7.. string

An optional string that specifies the trace output format.

configurePresets.trace.source@v7.. string | string[]
configurePresets.trace.redirect@v7.. string

An optional string specifying a path to a trace output file.

buildPresets@v2 object[]

An optional array of build preset objects.

buildPresets@v3 object[]

An optional array of build preset objects.

[email protected] object[]

An optional array of build preset objects.

buildPresets@v10.. object[]

An optional array of build preset objects.

buildPresets.name@v2.. string

A required string representing the machine-friendly name of the preset. This identifier is used in the cmake --build --preset option. There must not be two build presets in the union of CMakePresets.json and CMakeUserPresets.json in the same directory with the same name. However, a build preset may have the same name as a configure, test, package, or workflow preset.

buildPresets.hidden@v2.. boolean

An optional boolean specifying whether or not a preset should be hidden. If a preset is hidden, it cannot be used in the --preset argument and does not have to have a valid configurePreset, even from inheritance. hidden presets are intended to be used as a base for other presets to inherit via the inherits field.

buildPresets.inherits@v2.. string | string[]
buildPresets.condition@v10.. condition@v10.. | null
buildPresets.vendor@v2.. object

An optional map containing vendor-specific information. CMake does not interpret the contents of this field except to verify that it is a map if it does exist. However, it should follow the same conventions as the root-level vendor field.

buildPresets.displayName@v2.. string

An optional string with a human-friendly name of the preset.

buildPresets.description@v2.. string

An optional string with a human-friendly description of the preset.

buildPresets.environment@v2.. Record<string, null | string>

An optional map of environment variables. The key is the variable name (which must not be an empty string). Each variable is set regardless of whether or not a value was given to it by the process's environment. This field supports macro expansion, and environment variables in this map may reference each other, and may be listed in any order, as long as such references do not cause a cycle (for example,if ENV_1 is $env{ENV_2}, ENV_2 may not be $env{ENV_1}.) Environment variables are inherited through the inherits field, and the preset's environment will be the union of its own environment and the environment from all its parents. If multiple presets in this union define the same variable, the standard rules of inherits are applied. Setting a variable to null causes it to not be set, even if a value was inherited from another preset.

buildPresets.configurePreset@v2.. string

An optional string specifying the name of a configure preset to associate with this build preset. If configurePreset is not specified, it must be inherited from the inherits preset (unless this preset is hidden). The build tree directory is inferred from the configure preset.

buildPresets.inheritConfigureEnvironment@v2.. boolean

An optional boolean that defaults to true. If true, the environment variables from the associated configure preset are inherited after all inherited build preset environments, but before environment variables explicitly specified in this build preset.

buildPresets.jobs@v2.. integer

An optional non-negative integer. Equivalent to passing --parallel or -j on the command line.

buildPresets.targets@v2.. string | string[]
buildPresets.configuration@v2.. string

An optional string. Equivalent to passing --config on the command line.

buildPresets.cleanFirst@v2.. boolean

An optional boolean. If true, equivalent to passing --clean-first on the command line.

buildPresets.resolvePackageReferences@v4.. string

An optional string specifying the package resolve behavior. Valid values are "on" (packages are resolved prior to the build), "off" (packages are not resolved prior to the build), and "only" (packages are resolved, but no build will be performed).

buildPresets.verbose@v2.. boolean

An optional boolean. If true, equivalent to passing --verbose on the command line.

buildPresets.nativeToolOptions@v2.. string[]

An optional array of strings. Equivalent to passing options after -- on the command line.

testPresets@v2 object[]

An optional array of test preset objects. Used to specify arguments to ctest.

[email protected] object[]

An optional array of test preset objects. Used to specify arguments to ctest.

testPresets@v5 object[]

An optional array of test preset objects. Used to specify arguments to ctest.

[email protected] object[]

An optional array of test preset objects. Used to specify arguments to ctest.

testPresets@v10 object[]

An optional array of test preset objects. Used to specify arguments to ctest.

testPresets@v11 object[]

An optional array of test preset objects. Used to specify arguments to ctest.

testPresets@v12 object[]

An optional array of test preset objects. Used to specify arguments to ctest.

testPresets.name@v2.. string

A required string representing the machine-friendly name of the preset. This identifier is used in the ctest --preset option. There must not be two test presets in the union of CMakePresets.json and CMakeUserPresets.json in the same directory with the same name. However, a test preset may have the same name as a configure, build, package, or workflow preset.

testPresets.hidden@v2.. boolean

An optional boolean specifying whether or not a preset should be hidden. If a preset is hidden, it cannot be used in the --preset argument and does not have to have a valid configurePreset, even from inheritance. hidden presets are intended to be used as a base for other presets to inherit via the inherits field.

testPresets.inherits@v2.. string | string[]
testPresets.condition@v10.. condition@v10.. | null
testPresets.vendor@v2.. object

An optional map containing vendor-specific information. CMake does not interpret the contents of this field except to verify that it is a map if it does exist. However, it should follow the same conventions as the root-level vendor field.

testPresets.displayName@v2.. string

An optional string with a human-friendly name of the preset.

testPresets.description@v2.. string

An optional string with a human-friendly description of the preset.

testPresets.environment@v2.. Record<string, null | string>

An optional map of environment variables. The key is the variable name (which must not be an empty string). Each variable is set regardless of whether or not a value was given to it by the process's environment. This field supports macro expansion, and environment variables in this map may reference each other, and may be listed in any order, as long as such references do not cause a cycle (for example,if ENV_1 is $env{ENV_2}, ENV_2 may not be $env{ENV_1}.) Environment variables are inherited through the inherits field, and the preset's environment will be the union of its own environment and the environment from all its parents. If multiple presets in this union define the same variable, the standard rules of inherits are applied. Setting a variable to null causes it to not be set, even if a value was inherited from another preset.

testPresets.configurePreset@v2.. string

An optional string specifying the name of a configure preset to associate with this test preset. If configurePreset is not specified, it must be inherited from the inherits preset (unless this preset is hidden). The build directory is inferred from the configure preset.

testPresets.inheritConfigureEnvironment@v2.. boolean

An optional boolean that defaults to true. If true, the environment variables from the associated configure preset are inherited after all inherited test preset environments, but before environment variables explicitly specified in this test preset.

testPresets.configuration@v2.. string

An optional string. Equivalent to passing --build-config on the command line.

testPresets.overwriteConfigurationFile@v2.. string[]

An optional array of configuration options to overwrite options specified in the CTest configuration file. Equivalent to passing --overwrite for each value in the array.

[email protected] object

An optional object specifying output options.

shortProgress boolean

An optional boolean. If true, equivalent to passing --progress on the command line.

verbosity string

An optional string specifying verbosity level. Valid values are "default" (equivalent to passing no verbosity flags on the command line), "verbose" (equivalent to passing --verbose on the command line), and "extra" (equivalent to passing --extra-verbose on the command line).

Values: "default" "verbose" "extra"
debug boolean

An optional boolean. If true, equivalent to passing --debug on the command line.

outputOnFailure boolean

An optional boolean. If true, equivalent to passing --output-on-failure on the command line.

quiet boolean

An optional boolean. If true, equivalent to passing --quiet on the command line.

outputLogFile string

An optional string specifying a path to a log file. Equivalent to passing --output-log on the command line.

labelSummary boolean

An optional boolean. If false, equivalent to passing --no-label-summary on the command line.

subprojectSummary boolean

An optional boolean. If false, equivalent to passing --no-subproject-summary on the command line.

maxPassedTestOutputSize integer

An optional integer specifying the maximum output for passed tests in bytes. Equivalent to passing --test-output-size-passed on the command line.

maxFailedTestOutputSize integer

An optional integer specifying the maximum output for failed tests in bytes. Equivalent to passing --test-output-size-failed on the command line.

maxTestNameWidth integer

An optional integer specifying the maximum width of a test name to output. Equivalent to passing --max-width on the command line.

testPresets.output@v5 object

An optional object specifying output options.

shortProgress boolean

An optional boolean. If true, equivalent to passing --progress on the command line.

verbosity string

An optional string specifying verbosity level. Valid values are "default" (equivalent to passing no verbosity flags on the command line), "verbose" (equivalent to passing --verbose on the command line), and "extra" (equivalent to passing --extra-verbose on the command line).

Values: "default" "verbose" "extra"
debug boolean

An optional boolean. If true, equivalent to passing --debug on the command line.

outputOnFailure boolean

An optional boolean. If true, equivalent to passing --output-on-failure on the command line.

quiet boolean

An optional boolean. If true, equivalent to passing --quiet on the command line.

outputLogFile string

An optional string specifying a path to a log file. Equivalent to passing --output-log on the command line.

labelSummary boolean

An optional boolean. If false, equivalent to passing --no-label-summary on the command line.

subprojectSummary boolean

An optional boolean. If false, equivalent to passing --no-subproject-summary on the command line.

maxPassedTestOutputSize integer

An optional integer specifying the maximum output for passed tests in bytes. Equivalent to passing --test-output-size-passed on the command line.

maxFailedTestOutputSize integer

An optional integer specifying the maximum output for failed tests in bytes. Equivalent to passing --test-output-size-failed on the command line.

testOutputTruncation string

An optional string specifying the test output truncation mode. Equivalent to passing --test-output-truncation on the command line. Must be one of the following values: "tail", "middle", or "head".

Values: "tail" "middle" "head"
maxTestNameWidth integer

An optional integer specifying the maximum width of a test name to output. Equivalent to passing --max-width on the command line.

[email protected] object

An optional object specifying output options.

shortProgress boolean

An optional boolean. If true, equivalent to passing --progress on the command line.

verbosity string

An optional string specifying verbosity level. Valid values are "default" (equivalent to passing no verbosity flags on the command line), "verbose" (equivalent to passing --verbose on the command line), and "extra" (equivalent to passing --extra-verbose on the command line).

Values: "default" "verbose" "extra"
debug boolean

An optional boolean. If true, equivalent to passing --debug on the command line.

outputOnFailure boolean

An optional boolean. If true, equivalent to passing --output-on-failure on the command line.

quiet boolean

An optional boolean. If true, equivalent to passing --quiet on the command line.

outputLogFile string

An optional string specifying a path to a log file. Equivalent to passing --output-log on the command line.

outputJUnitFile string

An optional string specifying a path to a JUnit file. Equivalent to passing --output-junit on the command line.

labelSummary boolean

An optional boolean. If false, equivalent to passing --no-label-summary on the command line.

subprojectSummary boolean

An optional boolean. If false, equivalent to passing --no-subproject-summary on the command line.

maxPassedTestOutputSize integer

An optional integer specifying the maximum output for passed tests in bytes. Equivalent to passing --test-output-size-passed on the command line.

maxFailedTestOutputSize integer

An optional integer specifying the maximum output for failed tests in bytes. Equivalent to passing --test-output-size-failed on the command line.

testOutputTruncation string

An optional string specifying the test output truncation mode. Equivalent to passing --test-output-truncation on the command line. Must be one of the following values: "tail", "middle", or "head".

Values: "tail" "middle" "head"
maxTestNameWidth integer

An optional integer specifying the maximum width of a test name to output. Equivalent to passing --max-width on the command line.

testPresets.output@v10.. object

An optional object specifying output options.

shortProgress boolean

An optional boolean. If true, equivalent to passing --progress on the command line.

verbosity string

An optional string specifying verbosity level. Valid values are "default" (equivalent to passing no verbosity flags on the command line), "verbose" (equivalent to passing --verbose on the command line), and "extra" (equivalent to passing --extra-verbose on the command line).

Values: "default" "verbose" "extra"
debug boolean

An optional boolean. If true, equivalent to passing --debug on the command line.

outputOnFailure boolean

An optional boolean. If true, equivalent to passing --output-on-failure on the command line.

quiet boolean

An optional boolean. If true, equivalent to passing --quiet on the command line.

outputLogFile string

An optional string specifying a path to a log file. Equivalent to passing --output-log on the command line.

outputJUnitFile string

An optional string specifying a path to a JUnit file. Equivalent to passing --output-junit on the command line.

labelSummary boolean

An optional boolean. If false, equivalent to passing --no-label-summary on the command line.

subprojectSummary boolean

An optional boolean. If false, equivalent to passing --no-subproject-summary on the command line.

maxPassedTestOutputSize integer

An optional integer specifying the maximum output for passed tests in bytes. Equivalent to passing --test-output-size-passed on the command line.

maxFailedTestOutputSize integer

An optional integer specifying the maximum output for failed tests in bytes. Equivalent to passing --test-output-size-failed on the command line.

testOutputTruncation string

An optional string specifying the test output truncation mode. Equivalent to passing --test-output-truncation on the command line. Must be one of the following values: "tail", "middle", or "head".

Values: "tail" "middle" "head"
maxTestNameWidth integer

An optional integer specifying the maximum width of a test name to output. Equivalent to passing --max-width on the command line.

$comment comment@v10..
testPresets.output.shortProgress@v2.. boolean

An optional boolean. If true, equivalent to passing --progress on the command line.

testPresets.output.verbosity@v2.. string

An optional string specifying verbosity level. Valid values are "default" (equivalent to passing no verbosity flags on the command line), "verbose" (equivalent to passing --verbose on the command line), and "extra" (equivalent to passing --extra-verbose on the command line).

testPresets.output.debug@v2.. boolean

An optional boolean. If true, equivalent to passing --debug on the command line.

testPresets.output.outputOnFailure@v2.. boolean

An optional boolean. If true, equivalent to passing --output-on-failure on the command line.

testPresets.output.quiet@v2.. boolean

An optional boolean. If true, equivalent to passing --quiet on the command line.

testPresets.output.outputLogFile@v2.. string

An optional string specifying a path to a log file. Equivalent to passing --output-log on the command line.

testPresets.output.outputJUnitFile@v6.. string

An optional string specifying a path to a JUnit file. Equivalent to passing --output-junit on the command line.

testPresets.output.labelSummary@v2.. boolean

An optional boolean. If false, equivalent to passing --no-label-summary on the command line.

testPresets.output.subprojectSummary@v2.. boolean

An optional boolean. If false, equivalent to passing --no-subproject-summary on the command line.

testPresets.output.maxPassedTestOutputSize@v2.. integer

An optional integer specifying the maximum output for passed tests in bytes. Equivalent to passing --test-output-size-passed on the command line.

testPresets.output.maxFailedTestOutputSize@v2.. integer

An optional integer specifying the maximum output for failed tests in bytes. Equivalent to passing --test-output-size-failed on the command line.

testPresets.output.testOutputTruncation@v5.. string

An optional string specifying the test output truncation mode. Equivalent to passing --test-output-truncation on the command line. Must be one of the following values: "tail", "middle", or "head".

testPresets.output.maxTestNameWidth@v2.. integer

An optional integer specifying the maximum width of a test name to output. Equivalent to passing --max-width on the command line.

[email protected] object

An optional object specifying how to filter the tests to run.

include object

An optional object specifying which tests to include.

4 nested properties
name string

An optional string specifying a regex for test names. Equivalent to passing --tests-regex on the command line.

label string

An optional string specifying a regex for test labels. Equivalent to passing --label-regex on the command line.

useUnion boolean

An optional boolean. Equivalent to passing --union on the command line.

index string | object
exclude object

An optional object specifying which tests to exclude.

3 nested properties
name string

An optional string specifying a regex for test names. Equivalent to passing --exclude-regex on the command line.

label string

An optional string specifying a regex for test labels. Equivalent to passing --label-exclude on the command line.

fixtures object

An optional object specifying which fixtures to exclude from adding tests.

3 nested properties
any string

An optional string specifying a regex for text fixtures to exclude from adding any tests. Equivalent to passing --fixture-exclude-any on the command line.

setup string

An optional string specifying a regex for text fixtures to exclude from adding setup tests. Equivalent to passing --fixture-exclude-setup on the command line.

cleanup string

An optional string specifying a regex for text fixtures to exclude from adding cleanup tests. Equivalent to passing --fixture-exclude-cleanup on the command line.

testPresets.filter@v10.. object

An optional object specifying how to filter the tests to run.

include object

An optional object specifying which tests to include.

5 nested properties
name string

An optional string specifying a regex for test names. Equivalent to passing --tests-regex on the command line.

label string

An optional string specifying a regex for test labels. Equivalent to passing --label-regex on the command line.

useUnion boolean

An optional boolean. Equivalent to passing --union on the command line.

index string | object
$comment comment@v10..
exclude object

An optional object specifying which tests to exclude.

4 nested properties
name string

An optional string specifying a regex for test names. Equivalent to passing --exclude-regex on the command line.

label string

An optional string specifying a regex for test labels. Equivalent to passing --label-exclude on the command line.

fixtures object

An optional object specifying which fixtures to exclude from adding tests.

4 nested properties
any string

An optional string specifying a regex for text fixtures to exclude from adding any tests. Equivalent to passing --fixture-exclude-any on the command line.

setup string

An optional string specifying a regex for text fixtures to exclude from adding setup tests. Equivalent to passing --fixture-exclude-setup on the command line.

cleanup string

An optional string specifying a regex for text fixtures to exclude from adding cleanup tests. Equivalent to passing --fixture-exclude-cleanup on the command line.

$comment comment@v10..
$comment comment@v10..
$comment comment@v10..
[email protected] object

An optional object specifying which tests to include.

name string

An optional string specifying a regex for test names. Equivalent to passing --tests-regex on the command line.

label string

An optional string specifying a regex for test labels. Equivalent to passing --label-regex on the command line.

useUnion boolean

An optional boolean. Equivalent to passing --union on the command line.

index string | object
testPresets.filter.include@v10.. object

An optional object specifying which tests to include.

name string

An optional string specifying a regex for test names. Equivalent to passing --tests-regex on the command line.

label string

An optional string specifying a regex for test labels. Equivalent to passing --label-regex on the command line.

useUnion boolean

An optional boolean. Equivalent to passing --union on the command line.

index string | object
$comment comment@v10..
testPresets.filter.include.name@v2.. string

An optional string specifying a regex for test names. Equivalent to passing --tests-regex on the command line.

testPresets.filter.include.label@v2.. string

An optional string specifying a regex for test labels. Equivalent to passing --label-regex on the command line.

testPresets.filter.include.useUnion@v2.. boolean

An optional boolean. Equivalent to passing --union on the command line.

[email protected] string | object
testPresets.filter.include.index@v10.. string | object
testPresets.filter.include.index.start@v2.. integer

An optional integer specifying a test index at which to start testing.

testPresets.filter.include.index.end@v2.. integer

An optional integer specifying a test index at which to stop testing.

testPresets.filter.include.index.stride@v2.. integer

An optional integer specifying the increment.

testPresets.filter.include.index.specificTests@v2.. integer[]

An optional array of integers specifying specific test indices to run.

[email protected] object

An optional object specifying which tests to exclude.

name string

An optional string specifying a regex for test names. Equivalent to passing --exclude-regex on the command line.

label string

An optional string specifying a regex for test labels. Equivalent to passing --label-exclude on the command line.

fixtures object

An optional object specifying which fixtures to exclude from adding tests.

3 nested properties
any string

An optional string specifying a regex for text fixtures to exclude from adding any tests. Equivalent to passing --fixture-exclude-any on the command line.

setup string

An optional string specifying a regex for text fixtures to exclude from adding setup tests. Equivalent to passing --fixture-exclude-setup on the command line.

cleanup string

An optional string specifying a regex for text fixtures to exclude from adding cleanup tests. Equivalent to passing --fixture-exclude-cleanup on the command line.

testPresets.filter.exclude@v10.. object

An optional object specifying which tests to exclude.

name string

An optional string specifying a regex for test names. Equivalent to passing --exclude-regex on the command line.

label string

An optional string specifying a regex for test labels. Equivalent to passing --label-exclude on the command line.

fixtures object

An optional object specifying which fixtures to exclude from adding tests.

4 nested properties
any string

An optional string specifying a regex for text fixtures to exclude from adding any tests. Equivalent to passing --fixture-exclude-any on the command line.

setup string

An optional string specifying a regex for text fixtures to exclude from adding setup tests. Equivalent to passing --fixture-exclude-setup on the command line.

cleanup string

An optional string specifying a regex for text fixtures to exclude from adding cleanup tests. Equivalent to passing --fixture-exclude-cleanup on the command line.

$comment comment@v10..
$comment comment@v10..
testPresets.filter.exclude.name@v2.. string

An optional string specifying a regex for test names. Equivalent to passing --exclude-regex on the command line.

testPresets.filter.exclude.label@v2.. string

An optional string specifying a regex for test labels. Equivalent to passing --label-exclude on the command line.

[email protected] object

An optional object specifying which fixtures to exclude from adding tests.

any string

An optional string specifying a regex for text fixtures to exclude from adding any tests. Equivalent to passing --fixture-exclude-any on the command line.

setup string

An optional string specifying a regex for text fixtures to exclude from adding setup tests. Equivalent to passing --fixture-exclude-setup on the command line.

cleanup string

An optional string specifying a regex for text fixtures to exclude from adding cleanup tests. Equivalent to passing --fixture-exclude-cleanup on the command line.

testPresets.filter.exclude.fixtures@v10.. object

An optional object specifying which fixtures to exclude from adding tests.

any string

An optional string specifying a regex for text fixtures to exclude from adding any tests. Equivalent to passing --fixture-exclude-any on the command line.

setup string

An optional string specifying a regex for text fixtures to exclude from adding setup tests. Equivalent to passing --fixture-exclude-setup on the command line.

cleanup string

An optional string specifying a regex for text fixtures to exclude from adding cleanup tests. Equivalent to passing --fixture-exclude-cleanup on the command line.

$comment comment@v10..
testPresets.filter.exclude.fixtures.any@v2.. string

An optional string specifying a regex for text fixtures to exclude from adding any tests. Equivalent to passing --fixture-exclude-any on the command line.

testPresets.filter.exclude.fixtures.setup@v2.. string

An optional string specifying a regex for text fixtures to exclude from adding setup tests. Equivalent to passing --fixture-exclude-setup on the command line.

testPresets.filter.exclude.fixtures.cleanup@v2.. string

An optional string specifying a regex for text fixtures to exclude from adding cleanup tests. Equivalent to passing --fixture-exclude-cleanup on the command line.

[email protected] object

An optional object specifying options for test execution.

stopOnFailure boolean

An optional boolean. If true, equivalent to passing --stop-on-failure on the command line.

enableFailover boolean

An optional boolean. If true, equivalent to passing -F on the command line.

jobs integer

An optional non-negative integer. Equivalent to passing --parallel or -j on the command line.

min=0
resourceSpecFile string

An optional string. Equivalent to passing --resource-spec-file on the command line.

testLoad integer

An optional integer. Equivalent to passing --test-load on the command line.

showOnly string

An optional string. Equivalent to passing --show-only on the command line. Value must be "human" or "json-v1".

Values: "human" "json-v1"
repeat object

An optional object specifying how to repeat tests. Equivalent to passing --repeat on the command line.

2 nested properties
mode string required

A required string. Must be one of the following values: "until-fail", "until-pass", or "after-timeout".

Values: "until-fail" "until-pass" "after-timeout"
count integer required

A required integer.

interactiveDebugging boolean

An optional boolean. If true, equivalent to passing --interactive-debug-mode 1 on the command line. If false, equivalent to passing --interactive-debug-mode 0 on the command line.

scheduleRandom boolean

An optional boolean. If true, equivalent to passing --schedule-random on the command line.

timeout integer

An optional integer. Equivalent to passing --timeout on the command line.

noTestsAction string

An optional string specifying the behavior if no tests are found. Must be one of the following values: "default" (equivalent to not passing any value on the command line), "error" (equivalent to passing --no-tests=error on the command line), or "ignore" (equivalent to passing --no-tests-ignore on the command line).

Values: "default" "error" "ignore"
testPresets.execution@v10 object

An optional object specifying options for test execution.

stopOnFailure boolean

An optional boolean. If true, equivalent to passing --stop-on-failure on the command line.

enableFailover boolean

An optional boolean. If true, equivalent to passing -F on the command line.

jobs integer

An optional non-negative integer. Equivalent to passing --parallel or -j on the command line.

min=0
resourceSpecFile string

An optional string. Equivalent to passing --resource-spec-file on the command line.

testLoad integer

An optional integer. Equivalent to passing --test-load on the command line.

showOnly string

An optional string. Equivalent to passing --show-only on the command line. Value must be "human" or "json-v1".

Values: "human" "json-v1"
repeat object

An optional object specifying how to repeat tests. Equivalent to passing --repeat on the command line.

3 nested properties
mode string required

A required string. Must be one of the following values: "until-fail", "until-pass", or "after-timeout".

Values: "until-fail" "until-pass" "after-timeout"
count integer required

A required integer.

$comment comment@v10..
interactiveDebugging boolean

An optional boolean. If true, equivalent to passing --interactive-debug-mode 1 on the command line. If false, equivalent to passing --interactive-debug-mode 0 on the command line.

scheduleRandom boolean

An optional boolean. If true, equivalent to passing --schedule-random on the command line.

timeout integer

An optional integer. Equivalent to passing --timeout on the command line.

noTestsAction string

An optional string specifying the behavior if no tests are found. Must be one of the following values: "default" (equivalent to not passing any value on the command line), "error" (equivalent to passing --no-tests=error on the command line), or "ignore" (equivalent to passing --no-tests-ignore on the command line).

Values: "default" "error" "ignore"
$comment comment@v10..
testPresets.execution@v11 object

An optional object specifying options for test execution.

stopOnFailure boolean

An optional boolean. If true, equivalent to passing --stop-on-failure on the command line.

enableFailover boolean

An optional boolean. If true, equivalent to passing -F on the command line.

jobs integer | string
resourceSpecFile string

An optional string. Equivalent to passing --resource-spec-file on the command line.

testLoad integer

An optional integer. Equivalent to passing --test-load on the command line.

showOnly string

An optional string. Equivalent to passing --show-only on the command line. Value must be "human" or "json-v1".

Values: "human" "json-v1"
repeat object

An optional object specifying how to repeat tests. Equivalent to passing --repeat on the command line.

3 nested properties
mode string required

A required string. Must be one of the following values: "until-fail", "until-pass", or "after-timeout".

Values: "until-fail" "until-pass" "after-timeout"
count integer required

A required integer.

$comment comment@v10..
interactiveDebugging boolean

An optional boolean. If true, equivalent to passing --interactive-debug-mode 1 on the command line. If false, equivalent to passing --interactive-debug-mode 0 on the command line.

scheduleRandom boolean

An optional boolean. If true, equivalent to passing --schedule-random on the command line.

timeout integer

An optional integer. Equivalent to passing --timeout on the command line.

noTestsAction string

An optional string specifying the behavior if no tests are found. Must be one of the following values: "default" (equivalent to not passing any value on the command line), "error" (equivalent to passing --no-tests=error on the command line), or "ignore" (equivalent to passing --no-tests-ignore on the command line).

Values: "default" "error" "ignore"
$comment comment@v10..
testPresets.execution@v12 object

An optional object specifying options for test execution.

stopOnFailure boolean

An optional boolean. If true, equivalent to passing --stop-on-failure on the command line.

enableFailover boolean

An optional boolean. If true, equivalent to passing -F on the command line.

jobs integer | string
resourceSpecFile string

An optional string. Equivalent to passing --resource-spec-file on the command line.

testLoad integer

An optional integer. Equivalent to passing --test-load on the command line.

showOnly string

An optional string. Equivalent to passing --show-only on the command line. Value must be "human" or "json-v1".

Values: "human" "json-v1"
repeat object

An optional object specifying how to repeat tests. Equivalent to passing --repeat on the command line.

3 nested properties
mode string required

A required string. Must be one of the following values: "until-fail", "until-pass", or "after-timeout".

Values: "until-fail" "until-pass" "after-timeout"
count integer required

A required integer.

$comment comment@v10..
interactiveDebugging boolean

An optional boolean. If true, equivalent to passing --interactive-debug-mode 1 on the command line. If false, equivalent to passing --interactive-debug-mode 0 on the command line.

scheduleRandom boolean

An optional boolean. If true, equivalent to passing --schedule-random on the command line.

timeout integer

An optional integer. Equivalent to passing --timeout on the command line.

noTestsAction string

An optional string specifying the behavior if no tests are found. Must be one of the following values: "default" (equivalent to not passing any value on the command line), "error" (equivalent to passing --no-tests=error on the command line), or "ignore" (equivalent to passing --no-tests-ignore on the command line).

Values: "default" "error" "ignore"
testPassthroughArguments string[]

An optional array of strings. Each element is forwarded as an argument to every test executable. Equivalent to passing arguments after -- on the ctest command line.

$comment comment@v10..
testPresets.execution.stopOnFailure@v2.. boolean

An optional boolean. If true, equivalent to passing --stop-on-failure on the command line.

testPresets.execution.enableFailover@v2.. boolean

An optional boolean. If true, equivalent to passing -F on the command line.

[email protected] integer

An optional non-negative integer. Equivalent to passing --parallel or -j on the command line.

testPresets.execution.jobs@v11.. integer | string
testPresets.execution.resourceSpecFile@v2.. string

An optional string. Equivalent to passing --resource-spec-file on the command line.

testPresets.execution.testLoad@v2.. integer

An optional integer. Equivalent to passing --test-load on the command line.

testPresets.execution.showOnly@v2.. string

An optional string. Equivalent to passing --show-only on the command line. Value must be "human" or "json-v1".

[email protected] object

An optional object specifying how to repeat tests. Equivalent to passing --repeat on the command line.

mode string required

A required string. Must be one of the following values: "until-fail", "until-pass", or "after-timeout".

Values: "until-fail" "until-pass" "after-timeout"
count integer required

A required integer.

testPresets.execution.repeat@v10.. object

An optional object specifying how to repeat tests. Equivalent to passing --repeat on the command line.

mode string required

A required string. Must be one of the following values: "until-fail", "until-pass", or "after-timeout".

Values: "until-fail" "until-pass" "after-timeout"
count integer required

A required integer.

$comment comment@v10..
testPresets.execution.repeat.mode@v2.. string

A required string. Must be one of the following values: "until-fail", "until-pass", or "after-timeout".

testPresets.execution.repeat.count@v2.. integer

A required integer.

testPresets.execution.interactiveDebugging@v2.. boolean

An optional boolean. If true, equivalent to passing --interactive-debug-mode 1 on the command line. If false, equivalent to passing --interactive-debug-mode 0 on the command line.

testPresets.execution.scheduleRandom@v2.. boolean

An optional boolean. If true, equivalent to passing --schedule-random on the command line.

testPresets.execution.timeout@v2.. integer

An optional integer. Equivalent to passing --timeout on the command line.

testPresets.execution.noTestsAction@v2.. string

An optional string specifying the behavior if no tests are found. Must be one of the following values: "default" (equivalent to not passing any value on the command line), "error" (equivalent to passing --no-tests=error on the command line), or "ignore" (equivalent to passing --no-tests-ignore on the command line).

testPresets.execution.testPassthroughArguments@v12 string[]

An optional array of strings. Each element is forwarded as an argument to every test executable. Equivalent to passing arguments after -- on the ctest command line.

[email protected] object[]

An optional array of package preset objects. Used to specify arguments to cpack.

packagePresets@v10.. object[]

An optional array of package preset objects. Used to specify arguments to cpack.

packagePresets.name@v6.. string

A required string representing the machine-friendly name of the preset. This identifier is used in the cpack --preset option. There must not be two package presets in the union of CMakePresets.json and CMakeUserPresets.json in the same directory with the same name. However, a package preset may have the same name as a configure, build, test, or workflow preset.

packagePresets.hidden@v6.. boolean

An optional boolean specifying whether or not a preset should be hidden. If a preset is hidden, it cannot be used in the --preset argument and does not have to have a valid configurePreset, even from inheritance. hidden presets are intended to be used as a base for other presets to inherit via the inherits field.

packagePresets.inherits@v6.. string | string[]
packagePresets.condition@v10.. condition@v10.. | null
packagePresets.vendor@v6.. object

An optional map containing vendor-specific information. CMake does not interpret the contents of this field except to verify that it is a map if it does exist. However, it should follow the same conventions as the root-level vendor field.

packagePresets.displayName@v6.. string

An optional string with a human-friendly name of the preset.

packagePresets.description@v6.. string

An optional string with a human-friendly description of the preset.

packagePresets.environment@v6.. Record<string, null | string>

An optional map of environment variables. The key is the variable name (which must not be an empty string). Each variable is set regardless of whether or not a value was given to it by the process's environment. This field supports macro expansion, and environment variables in this map may reference each other, and may be listed in any order, as long as such references do not cause a cycle (for example,if ENV_1 is $env{ENV_2}, ENV_2 may not be $env{ENV_1}.) Environment variables are inherited through the inherits field, and the preset's environment will be the union of its own environment and the environment from all its parents. If multiple presets in this union define the same variable, the standard rules of inherits are applied. Setting a variable to null causes it to not be set, even if a value was inherited from another preset.

packagePresets.configurePreset@v6.. string

An optional string specifying the name of a configure preset to associate with this package preset. If configurePreset is not specified, it must be inherited from the inherits preset (unless this preset is hidden). The build tree directory is inferred from the configure preset.

packagePresets.inheritConfigureEnvironment@v6.. boolean

An optional boolean that defaults to true. If true, the environment variables from the associated configure preset are inherited after all inherited package preset environments, but before environment variables explicitly specified in this package preset.

packagePresets.generators@v6.. string[]

An optional array of strings representing generators for CPack to use.

packagePresets.configurations@v6.. string[]

An optional array of strings representing build configurations for CPack to package.

packagePresets.variables@v6.. Record<string, string>

An optional map of variables to pass to CPack, equivalent to -D arguments. Each key is the name of a variable, and the value is the string to assign to that variable.

packagePresets.configFile@v6.. string

An optional string representing the config file for CPack to use.

[email protected] object

An optional object specifying output options.

debug boolean

An optional boolean specifying whether or not to print debug information. A value of true is equivalent to passing --debug on the command line.

verbose boolean

An optional boolean specifying whether or not to print verbosely. A value of true is equivalent to passing --verbose on the command line.

packagePresets.output@v10.. object

An optional object specifying output options.

debug boolean

An optional boolean specifying whether or not to print debug information. A value of true is equivalent to passing --debug on the command line.

verbose boolean

An optional boolean specifying whether or not to print verbosely. A value of true is equivalent to passing --verbose on the command line.

$comment comment@v10..
packagePresets.output.debug@v6.. boolean

An optional boolean specifying whether or not to print debug information. A value of true is equivalent to passing --debug on the command line.

packagePresets.output.verbose@v6.. boolean

An optional boolean specifying whether or not to print verbosely. A value of true is equivalent to passing --verbose on the command line.

packagePresets.packageName@v6.. string

An optional string representing the package name.

packagePresets.packageVersion@v6.. string

An optional string representing the package version.

packagePresets.packageDirectory@v6.. string

An optional string representing the directory in which to place the package.

packagePresets.vendorName@v6.. string

An optional string representing the vendor name.

[email protected] object[]

An optional array of workflow preset objects. Used to execute configure, build, test, and package presets in order.

workflowPresets@v10.. object[]

An optional array of workflow preset objects. Used to execute configure, build, test, and package presets in order.

workflowPresets.name@v6.. string

A required string representing the machine-friendly name of the preset. This identifier is used in the cmake --workflow --preset option. There must not be two presets (configure, build, test, package, or workflow) in the union of CMakePresets.json and CMakeUserPresets.json in the same directory with the same name. However, a workflow preset may have the same name as a configure, build, test, or package preset.

workflowPresets.vendor@v6.. object

An optional map containing vendor-specific information. CMake does not interpret the contents of this field except to verify that it is a map if it does exist. However, it should follow the same conventions as the root-level vendor field.

workflowPresets.displayName@v6.. string

An optional string with a human-friendly name of the preset.

workflowPresets.description@v6.. string

An optional string with a human-friendly description of the preset.

[email protected] object[]

A required array of objects describing the steps of the workflow. The first step must be a configure preset, and all subsequent steps must be non-configure presets whose configurePreset field matches the starting configure preset.

workflowPresets.steps@v10.. object[]

A required array of objects describing the steps of the workflow. The first step must be a configure preset, and all subsequent steps must be non-configure presets whose configurePreset field matches the starting configure preset.

workflowPresets.steps.type@v6.. string

A required string. The first step must be configure. Subsequent steps must be either build, test, or package.

workflowPresets.steps.name@v6.. string

A required string representing the name of the configure, build, test, or package preset to run as this workflow step.

condition[1].type@v3.. string

A required string specifying the type of the condition.

condition[1].value@v3.. boolean

A required boolean which provides a constant value for the condition's evaluation.

condition[2].type@v3.. string

A required string specifying the type of the condition.

condition[2].lhs@v3.. string

First string to compare. This field supports macro expansion.

condition[2].rhs@v3.. string

Second string to compare. This field supports macro expansion.

condition[3].type@v3.. string

A required string specifying the type of the condition.

condition[3].string@v3.. string

A required string to search for. This field supports macro expansion.

condition[3].list@v3.. string[]

A required array of strings to search. This field supports macro expansion, and uses short-circuit evaluation.

condition[4].type@v3.. string

A required string specifying the type of the condition.

condition[4].string@v3.. string

A required string to search. This field supports macro expansion.

condition[4].regex@v3.. string

A required regular expression to search for. This field supports macro expansion.

condition[5].type@v3.. string

A required string specifying the type of the condition.

condition[5][email protected] [email protected][]

A required array of condition objects. These conditions use short-circuit evaluation.

condition[5].conditions@v10.. condition@v10..[]

A required array of condition objects. These conditions use short-circuit evaluation.

condition[6].type@v3.. string

A required string specifying the type of the condition.

condition[6][email protected] boolean | object | object | object | object | object | object
condition[6].condition@v10.. boolean | object | object | object | object | object | object
[email protected] boolean | object | object | object | object | object | object
condition@v10.. boolean | object | object | object | object | object | object