如何分离Build Preset与Configuration？VS Code多配置项目咨询

1. 分层拆分Preset的核心思路 #

把**平台+构建类型（Debug/Release）和预处理器预设（A/B/C）**拆分为两个独立维度，通过CMake Preset的继承和矩阵功能自动生成所有组合，避免重复编写配置。

1.1 定义Configure Preset：负责平台+Debug/Release #

Configure Preset专注于基础构建环境：操作系统、编译器、构建类型，用继承减少重复代码：

{
  "version": 3,
  "configurePresets": [
    // Windows基础预设（隐藏，仅用于继承）
    {
      "name": "base-windows",
      "hidden": true,
      "generator": "Ninja",
      "binaryDir": "${sourceDir}/build/${presetName}",
      "condition": {
        "type": "equals",
        "lhs": "${hostSystemName}",
        "rhs": "Windows"
      }
    },
    {
      "name": "windows-debug",
      "inherits": "base-windows",
      "cacheVariables": {
        "CMAKE_BUILD_TYPE": "Debug",
        "CMAKE_CXX_FLAGS_DEBUG": "-Od -Zi"
      }
    },
    {
      "name": "windows-release",
      "inherits": "base-windows",
      "cacheVariables": {
        "CMAKE_BUILD_TYPE": "Release",
        "CMAKE_CXX_FLAGS_RELEASE": "-O2 -Ob2"
      }
    },
    // Linux基础预设（隐藏，仅用于继承）
    {
      "name": "base-linux",
      "hidden": true,
      "generator": "Ninja",
      "binaryDir": "${sourceDir}/build/${presetName}",
      "condition": {
        "type": "equals",
        "lhs": "${hostSystemName}",
        "rhs": "Linux"
      }
    },
    {
      "name": "linux-debug",
      "inherits": "base-linux",
      "cacheVariables": {
        "CMAKE_BUILD_TYPE": "Debug",
        "CMAKE_CXX_FLAGS_DEBUG": "-O0 -g"
      }
    },
    {
      "name": "linux-release",
      "inherits": "base-linux",
      "cacheVariables": {
        "CMAKE_BUILD_TYPE": "Release",
        "CMAKE_CXX_FLAGS_RELEASE": "-O3 -DNDEBUG"
      }
    }
  ]
}

1.2 定义Build Preset：负责A/B/C预处理器预设 #

先抽离A/B/C的预定义逻辑为基础Build Preset，再通过矩阵扩展自动组合所有平台+类型+预设的组合：

"buildPresets": [
  // 预处理器预设基础配置
  {
    "name": "preset-a",
    "cacheVariables": {
      "USE_PRESET_A": "ON",
      "USE_PRESET_B": "OFF",
      "USE_PRESET_C": "OFF"
    }
  },
  {
    "name": "preset-b",
    "cacheVariables": {
      "USE_PRESET_A": "OFF",
      "USE_PRESET_B": "ON",
      "USE_PRESET_C": "OFF"
    }
  },
  {
    "name": "preset-c",
    "cacheVariables": {
      "USE_PRESET_A": "OFF",
      "USE_PRESET_B": "OFF",
      "USE_PRESET_C": "ON"
    }
  },
  // 自动生成所有12种组合
  {
    "name": "combined-presets",
    "matrix": {
      "include": [
        {"configurePreset": "windows-debug", "inherits": "preset-a"},
        {"configurePreset": "windows-debug", "inherits": "preset-b"},
        {"configurePreset": "windows-debug", "inherits": "preset-c"},
        {"configurePreset": "windows-release", "inherits": "preset-a"},
        {"configurePreset": "windows-release", "inherits": "preset-b"},
        {"configurePreset": "windows-release", "inherits": "preset-c"},
        {"configurePreset": "linux-debug", "inherits": "preset-a"},
        {"configurePreset": "linux-debug", "inherits": "preset-b"},
        {"configurePreset": "linux-debug", "inherits": "preset-c"},
        {"configurePreset": "linux-release", "inherits": "preset-a"},
        {"configurePreset": "linux-release", "inherits": "preset-b"},
        {"configurePreset": "linux-release", "inherits": "preset-c"}
      ]
    },
    "namePattern": "${configurePreset}-${inherits}"
  }
]

这样会自动生成如windows-debug-preset-a、linux-release-preset-c等12个完整配置，既分开了A/B/C和Debug/Release的定义，又无需手动编写每个组合。

2. 解决Build Preset必须指定configurePreset的问题 #

Build Preset需要关联configurePreset本质是CMake要知道构建目录。如果不想硬绑定，有两种方案：

• 指定binaryDir：直接在Build Preset中写死构建目录路径，比如"binaryDir": "${sourceDir}/build/windows-debug"，跳过configurePreset字段。
• 用环境变量动态指定：通过${env:ACTIVE_CONFIG_DIR}这类环境变量传递构建目录，适合脚本化构建场景。

但矩阵+继承的方案是最省心的，既保持了配置分离，又自动完成了绑定。

3. VSCode中解绑Configuration Preset与Build Preset #

VSCode的CMake Tools扩展默认会关联二者，但可以通过以下方式完全解绑：

3.1 修改settings.json关闭自动关联 #

在.vscode/settings.json中添加：

{
  "cmake.configureOnBuild": false,
  "cmake.buildBeforeRun": false,
  "cmake.presets.configure": "",
  "cmake.presets.build": ""
}

之后你可以手动选择Configure Preset执行配置，再选择Build Preset执行构建，二者完全独立。

3.2 使用自定义任务 #

在.vscode/tasks.json中创建独立的构建任务，比如：

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Build Preset A",
      "type": "cmake",
      "command": "build",
      "args": ["--preset", "preset-a"],
      "problemMatcher": ["$gcc", "$msCompile"]
    },
    {
      "label": "Build Preset B",
      "type": "cmake",
      "command": "build",
      "args": ["--preset", "preset-b"],
      "problemMatcher": ["$gcc", "$msCompile"]
    }
  ]
}

直接运行这些任务即可，无需依赖VSCode的预设关联逻辑。

另外，VSCode状态栏的CMake工具入口可以分别选择Configure和Build Preset，先选Configure点击"Configure"，再选Build点击"Build"，本身就是独立操作。

4. 额外优化建议 #

• 在CMakeLists.txt中统一管理预定义：用option和target_compile_definitions替代Preset中的硬编码，比如：

  option(USE_PRESET_A "Enable Preset A features" OFF)
  if(USE_PRESET_A)
    add_compile_definitions(PRESET_A)
  endif()
  

• 隐藏基础Preset：把用于继承的基础Preset设为"hidden": true，避免VSCode菜单出现过多冗余选项。
• 平台自动适配：利用Configure Preset的condition字段自动识别当前操作系统，无需手动切换平台预设。

内容的提问来源于stack exchange，提问作者Victor