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 checkThe presets specify the generator and the build directory, and optionally a list of variables and other arguments to pass to CMake.
One of
Definitions
The schema against which to verify this document.
A required string representing the machine-friendly name of the preset. This identifier is used in the --preset argument. 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.
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.
An optional string with a human-friendly name of the preset.
An optional string with a human-friendly description of the preset.
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.
An optional integer representing the major version.
An optional integer representing the minor version.
An optional integer representing the patch version.
An optional object representing the minimum version of CMake needed to build this project. Available in version 10 and higher.
An optional object representing the minimum version of CMake needed to build this project. Available in version 1 and higher.
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.
An optional string representing the platform for generators that support it.
An optional string representing the value.
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.
An optional string representing the toolset for generators that support it.
An optional string representing the value.
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.
Setting a variable to null causes it to not be set, even if a value was inherited from another preset.
A boolean representing the value of the variable. Equivalent to "TRUE" or "FALSE".
A string representing the value of the variable (which supports macro expansion).
An optional string representing the type of the variable. It should be BOOL, FILEPATH, PATH, STRING, or INTERNAL.
An optional object specifying trace options.
An optional object specifying trace options.
An optional string that specifies the trace mode.
An optional string that specifies the trace output format.
An optional string specifying a path to a trace output file.
An optional object specifying debug options.
An optional object specifying debug options.
An optional object specifying errors.
An optional object specifying errors.
An optional object specifying warnings.
An optional object specifying warnings.
An optional boolean. Setting this to true is equivalent to passing --debug-output on the command line.
An optional boolean. Setting this to true is equivalent to passing --debug-trycompile on the command line.
An optional boolean. Setting this to true is equivalent to passing --debug-find on the command line.
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.
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.
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.
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.
An optional boolean. Setting this to true is equivalent to passing --warn-uninitialized on the command line.
An optional boolean. Setting this to false is equivalent to passing --no-warn-unused-cli on the command line.
An optional boolean. Setting this to true is equivalent to passing --check-system-vars on the command line.
An optional string specifying the path to graphviz dot file. Available in version 10 and higher.
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.
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.
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.
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.
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.
An optional object specifying warnings.
An optional object specifying debug options.
An optional object specifying trace options.
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.
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).
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.
An optional array of configure preset objects. Available in version 10 and higher.
An optional array of configure preset objects. Available in version 7 and higher.
An optional array of configure preset objects. Available in version 3 and higher.
An optional array of configure preset objects. Available in version 1 and higher.
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).
An optional array of build preset objects. Used to specify arguments to cmake --build. Available in version 10 and higher.
An optional array of build preset objects. Used to specify arguments to cmake --build. Available in version 4 and higher.
An optional array of build preset objects. Used to specify arguments to cmake --build. Available in version 3 and higher.
An optional array of build preset objects. Used to specify arguments to cmake --build. Available in version 2 and higher.
An optional non-negative integer. Equivalent to passing --parallel or -j on the command line.
An optional object specifying how to repeat tests. Equivalent to passing --repeat on the command line.
An optional object specifying how to repeat tests. Equivalent to passing --repeat on the command line.
A required string. Must be one of the following values: "until-fail", "until-pass", or "after-timeout".
A required integer.
An optional string specifying a file with the command line syntax for --tests-information. Available in version 2 and higher.
An optional object specifying tests to include by test index. Available in version 10 and higher.
An optional object specifying tests to include by test index. Available in version 2 and higher.
An optional integer specifying a test index to start testing at.
An optional integer specifying a test index to stop testing at.
An optional integer specifying the increment.
An optional array of integers specifying specific test indices to run.
An optional object specifying which tests to include.
An optional object specifying which tests to include.
An optional string specifying a regex for test names. Equivalent to passing --tests-regex on the command line.
An optional string specifying a regex for test labels. Equivalent to passing --label-regex on the command line.
An optional boolean. Equivalent to passing --union on the command line.
An optional object specifying which tests to exclude.
An optional object specifying which tests to exclude.
An optional object specifying which fixtures to exclude from adding tests.
An optional string specifying a regex for text fixtures to exclude from adding any tests. Equivalent to --fixture-exclude-any on the command line.
An optional string specifying a regex for text fixtures to exclude from adding setup tests. Equivalent to --fixture-exclude-setup on the command line.
An optional string specifying a regex for text fixtures to exclude from adding cleanup tests. Equivalent to --fixture-exclude-cleanup on the command line.
An optional string specifying a regex for test names. Equivalent to passing --exclude-regex on the command line.
An optional string specifying a regex for test labels. Equivalent to passing --label-exclude on the command line.
An optional object specifying options for test execution.
An optional object specifying options for test execution.
An optional object specifying options for test execution.
An optional object specifying options for test execution.
An optional boolean. If true, equivalent to passing --stop-on-failure on the command line.
An optional boolean. If true, equivalent to passing -F on the command line.
An optional string. Equivalent to passing --resource-spec-file on the command line.
An optional integer. Equivalent to passing --test-load on the command line.
An optional string. Equivalent to passing --show-only on the command line. Value must be "human" or "json-v1".
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.
An optional boolean. If true, equivalent to passing --schedule-random on the command line.
An optional integer. Equivalent to passing --timeout on the command line.
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).
An optional string specifying a path to a JUnit file. Equivalent to passing --output-junit on the command line.
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".
An optional object specifying output options.
An optional object specifying output options.
An optional object specifying output options.
An optional object specifying output options.
An optional boolean. If true, equivalent to passing --progress on the command line.
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).
An optional boolean. If true, equivalent to passing --debug on the command line.
An optional boolean. If true, equivalent to passing --output-on-failure on the command line.
An optional boolean. If true, equivalent to passing --quiet on the command line.
An optional string specifying a path to a log file. Equivalent to passing --output-log on the command line.
An optional boolean. If false, equivalent to passing --no-label-summary on the command line.
An optional boolean. If false, equivalent to passing --no-subproject-summary on the command line.
An optional integer specifying the maximum output for passed tests in bytes. Equivalent to passing --test-output-size-passed on the command line.
An optional integer specifying the maximum output for failed tests in bytes. Equivalent to passing --test-output-size-failed on the command line.
An optional integer specifying the maximum width of a test name to output. Equivalent to passing --max-width on the command line.
An optional object specifying options for test execution.
An optional object specifying how to filter the tests to run.
An optional object specifying options for test execution.
An optional object specifying how to filter the tests to run.
An optional object specifying options for test execution.
An optional object specifying how to filter the tests to run.
An optional object specifying options for test execution.
An optional object specifying how to filter the tests to run.
2 nested properties
An optional object specifying which tests to include.
An optional object specifying which tests to exclude.
An optional object specifying options for test execution.
An optional object specifying how to filter the tests to run.
2 nested properties
An optional object specifying which tests to include.
An optional object specifying which tests to exclude.
An optional object specifying options for test execution.
An optional object specifying how to filter the tests to run.
2 nested properties
An optional object specifying which tests to include.
An optional object specifying which tests to exclude.
An optional array of test preset objects. Used to specify arguments to ctest. Available in version 12 and higher.
An optional array of test preset objects. Used to specify arguments to ctest. Available in version 11 and higher.
An optional array of test preset objects. Used to specify arguments to ctest. Available in version 10 and higher.
An optional array of test preset objects. Used to specify arguments to ctest. Available in version 6 and higher.
An optional array of test preset objects. Used to specify arguments to ctest. Available in version 5 and higher.
An optional array of test preset objects. Used to specify arguments to ctest. Available in version 3 and higher.
An optional array of test preset objects. Used to specify arguments to ctest. Available in version 2 and higher.
An optional object specifying output options.
An optional object specifying output options.
An optional boolean specifying whether or not to print debug information. A value of true is equivalent to passing --debug on the command line.
An optional boolean specifying whether or not to print verbosely. A value of true is equivalent to passing --verbose on the command line.
An optional object specifying output options.
An optional array of package preset objects. Used to specify arguments to cpack. Available in version 10 and higher.
An optional array of package preset objects. Used to specify arguments to cpack. Available in version 6 and higher.
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.
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.
A required string. The first step must be configure. Subsequent steps must be either build, test, or package.
A required string representing the name of the configure, build, test, or package preset to run as this workflow step.
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.
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.
An optional array of workflow preset objects. Used to execute configure, build, test, and package presets in order. Available in version 10 and higher.
An optional array of workflow preset objects. Used to execute configure, build, test, and package presets in order. Available in version 6 and higher.
A boolean which provides a constant value for the condition's evaluation.
A required string specifying the type of the condition.
A required boolean which provides a constant value for the condition's evaluation.
A required string specifying the type of the condition.
First string to compare. This field supports macro expansion.
Second string to compare. This field supports macro expansion.
A required string specifying the type of the condition.
A required string to search for. This field supports macro expansion.
A required list of strings to search. This field supports macro expansion, and uses short-circuit evaluation.
A required string specifying the type of the condition.
A required string to search. This field supports macro expansion.
A required regular expression to search for. This field supports macro expansion.
A required string specifying the type of the condition.
A required array of condition objects. These conditions use short-circuit evaluation.
A required string specifying the type of the condition.
Null indicates that the condition always evaluates to true and is not inherited.
An optional array of strings representing files to include. If the filenames are not absolute, they are considered relative to the current file.