【免费下载】 Visual Studio Code CMake Tools 中的 CMake Presets 使用指南

Visual Studio Code CMake Tools 中的 CMake Presets 使用指南

【免费下载链接】vscode-cmake-tools CMake integration in Visual Studio Code 项目地址: https://gitcode.com/gh_mirrors/vs/vscode-cmake-tools

什么是 CMake Presets

CMake Presets 是 CMake 提供的一种标准化配置方式，通过 CMakePresets.json 和 CMakeUserPresets.json 两个文件来管理项目的配置、构建和测试选项。这种方式可以：

• 统一团队开发环境配置
• 简化复杂项目的构建流程
• 方便持续集成(CI)环境使用
• 支持跨平台开发

CMakePresets.json 用于保存项目级别的构建配置，而 CMakeUserPresets.json 则用于开发者保存个人本地构建配置。

版本要求

使用 CMake Presets 需要满足以下版本要求：

1. CMakePresets.json 文件版本需为 2 或更高
2. 推荐使用 CMake 3.14 或更高版本
3. 从命令行调用 CMake 时，需要 CMake 3.20 或更高版本

启用 CMake Presets 支持

在 Visual Studio Code 中，可以通过修改 settings.json 文件来配置 CMake Presets 的使用：

{
    "cmake.useCMakePresets": "auto"  // 可选值: "always", "never", "auto"
}

• auto: 自动检测，如果项目目录下有 CMakePresets.json 文件则启用
• always: 总是启用
• never: 禁用此功能

核心功能使用

1. 配置预设(Configure Presets)

配置预设定义了如何配置 CMake 项目。在 VS Code 中可以通过以下方式使用：

1. 打开命令面板(Ctrl+Shift+P)
2. 输入并选择 "CMake: Select Configure Preset"
3. 从列表中选择一个配置预设

选择后，该预设会显示在 CMake Tools 侧边栏的项目状态视图中。

2. 构建预设(Build Presets)

构建预设定义了如何构建项目：

1. 使用 "CMake: Select Build Preset" 命令选择构建预设
2. 使用 "CMake: Build" 命令构建整个项目
3. 使用 "CMake: Build Target" 命令构建特定目标

3. 测试预设(Test Presets)

测试预设用于定义如何运行测试：

1. 使用 "CMake: Select Test Preset" 命令选择测试预设
2. 使用 "CMake: Run Tests" 命令运行测试

添加新预设

添加配置预设

1. 使用 "CMake: Add Configure Preset" 命令
2. 选择模板类型：
   • 继承现有配置预设
   • 使用工具链文件
   • 自定义空预设
   • 扫描编译器

添加构建预设

1. 使用 "CMake: Add Build Preset" 命令
2. 选择创建方式：
   • 基于配置预设创建
   • 继承现有构建预设
   • 自定义空预设

添加测试预设

1. 使用 "CMake: Add Test Preset" 命令
2. 选择创建方式：
   • 基于配置预设创建
   • 继承现有测试预设
   • 自定义空预设

预设编辑技巧

设置编译器

在配置预设中，可以通过 cacheVariables 设置编译器：

"cacheVariables": {
    "CMAKE_C_COMPILER": "gcc",
    "CMAKE_CXX_COMPILER": "g++",
    "CMAKE_BUILD_TYPE": "Debug"
}

选择生成器

通过 generator 选项指定 CMake 生成器：

"generator": "Ninja"

Windows 平台常用 Visual Studio 生成器，Linux/macOS 常用 Ninja。

环境变量管理

可以在预设中设置环境变量：

"environment": {
    "MY_ENV_VAR": "value"
}

变量引用使用 $env{VAR_NAME} 语法。

架构设置

使用 Visual C++ 工具集时，可以设置目标架构：

"architecture": {
    "value": "x64",
    "strategy": "set"
}

最佳实践

1. 项目级别的预设放在 CMakePresets.json 中
2. 个人定制化的预设放在 CMakeUserPresets.json 中
3. 使用继承减少重复配置
4. 路径使用正斜杠(/)以保证跨平台兼容性
5. 避免使用绝对路径，保持配置的可共享性

通过合理使用 CMake Presets，可以显著提高 CMake 项目的开发效率和团队协作体验。

【免费下载链接】vscode-cmake-tools CMake integration in Visual Studio Code 项目地址: https://gitcode.com/gh_mirrors/vs/vscode-cmake-tools