CMakePresets.json
CMakePresets.json
简介
在使用 CMake 过程中，我们经常面临的一个问题是如何与其他人共享设置以获取配置项目的常用方法。这样做可以更好的支持 CI 构建，也可以使大多编译项目的人可以便捷的使用相同配置进行构建。
CMake （译者注：v3.19以上版本）支持两个主要配置文件：
- CMakePresets.json
- CMakeUserPresets.json
区别与相似点
相同点：
用来支持用户指定常用配置选项并与他人共享。CMake 还支持包含在 include 字段中的文件（译者注：比如一个 presets 可以 include 另一个 presets 文件，需要注意的是 CMakeUserPresets.json 隐式包含 CMakePresets.json，且禁止循环包含，具体查看下文文档）。
CMakePresets.json 与 CMakeUserPresets.json 位于项目的根目录中。它们都具有完全相同的格式，并且都是可选的（尽管如果指定了 --preset 则二者至少必须存在一个）。
区别：
CMakePresets.json 旨在指定项目范围的构建细节，而 CMakeUserPresets.json 旨在让开发人员自定义他们自己的本地构建细节。
gitignore补充
- CMakePresets.json 可能会被检入版本控制系统（译者注：通常应该检入，这样CI可以使用默认配置，团队其他成员也一样）
- 而 CMakeUserPresets.json 不应被检入。例如，如果项目正在使用 Git，则可能会跟踪 CMakePresets.json，并且应将 CMakeUserPresets.json 添加到 .gitignore .
格式
这些文件是一个以对象为根的 JSON 文档：
- version：表示 JSON 模式版本的必需整数。支持的版本是
1、2、3和4 - cmakeMinimumRequired：一个可选对象，表示构建此项目所需的最低 CMake 版本。该对象由以下字段组成：
major：表示主要版本的可选整数。minor：表示次要版本的可选整数。patch：表示补丁版本的可选整数。
- include：表示要包含的文件的可选字符串数组。如果文件名不是绝对的，则它们被认为是相对于当前文件的。
4这在指定版本或更高版本的预设文件中是允许的。有关包含文件的约束的讨论，请参见包含。 - vendor：包含供应商特定信息的可选映射。CMake 不解释此字段的内容，除非它确实存在验证它是否是一个映射。但是，密钥应该是供应商特定的域名，后跟 - 分隔的
/路径。例如，示例 IDE 1.0 可以使用example.com/ExampleIDE/1.0. 每个字段的值可以是供应商所需的任何值，但通常是地图。 - configurePresets：可选的配置预设对象数组。
1这在指定版本或更高版本的预设文件中是允许的。 - buildPresets：可选的构建预设对象数组。
2这在指定版本或更高版本的预设文件中是允许 - testPresets：一个可选的测试预设对象数组。
2这在指定版本或更高版本的预设文件中是允许的。
包括
CMakePresets.json并且CMakeUserPresets.json可以在文件版本及更高版本中包含具有该include字段的其他文件。4这些文件包含的文件也可以包含其他文件。如果CMakePresets.json和 CMakeUserPresets.json都存在，则在所有版本的格式中CMakeUserPresets.json 隐式包含CMakePresets.json，即使没有字段。include
如果预设文件包含从另一个文件中的预设继承的预设，则该文件必须直接或间接包含另一个文件。文件之间不允许包含循环。如果a.json包含 b.json，b.json则不能包含a.json。但是，同一文件或不同文件中可能会多次包含一个文件。
直接或间接包含的文件CMakePresets.json应保证由项目提供。CMakeUserPresets.json可能包括来自任何地方的文件。