为何CMakePresets.json会阻止VS Code为多配置CMake项目传递--config参数？

问题描述 #

我正从CLI为主的开发环境转向IDE驱动环境，遇到VS Code与CMake命令交互的问题：

• 使用Visual Studio 17 2022多配置生成器时，若项目存在CMakePresets.json，VS Code构建时不会向cmake.exe传递--config参数，导致编译二进制文件生成在非预期位置（如Release构建的gmock.lib出现在Debug目录）
• 无该文件时则会自动传递参数，且CMake面板有Release/Debug选项

我原本认为CMakePresets.json仅作用于CMake生成阶段，现在需要搞清楚：

1. 它在构建阶段的作用
2. 与VS Code的交互逻辑
3. 如何同时使用该文件并让IDE为多配置构建正确应用--config参数

附当前CMakePresets.json配置：

{
  "version": 3,
  "configurePresets": [
    {
      "name": "windows-base",
      "description": "Target Windows with the Visual Studio development environment.",
      "hidden": true,
      "generator": "Visual Studio 17 2022",
      "binaryDir": "${sourceDir}/out/vscode/build/${presetName}",
      "installDir": "${sourceDir}/out/vscode/install/${presetName}",
      "cacheVariables": {
        "gtest_force_shared_crt": {
          "type": "BOOL",
          "value":  "ON"
        }
      },
      "condition": {
        "type": "equals",
        "lhs": "${hostSystemName}",
        "rhs": "Windows"
      }
    },
    {
      "name": "x64-debug",
      "displayName": "x64 Debug",
      "description": "Target Windows (64-bit) with the Visual Studio development environment. (Debug)",
      "inherits": "windows-base",
      "architecture": {
        "value": "x64",
        "strategy": "external"
      },
      "cacheVariables": { "CMAKE_BUILD_TYPE": "Debug" }
    },
    {
      "name": "x64-release",
      "displayName": "x64 Release",
      "description": "Target Windows (64-bit) with the Visual Studio development environment. (RelWithDebInfo)",
      "inherits": "windows-base",
      "cacheVariables": { "CMAKE_BUILD_TYPE": "Release" }
    },
    {
      "name": "x86-debug",
      "displayName": "x86 Debug",
      "description": "Target Windows (32-bit) with the Visual Studio development environment. (Debug)",
      "inherits": "windows-base",
      "architecture": {
        "value": "x86",
        "strategy": "external"
      },
      "cacheVariables": { "CMAKE_BUILD_TYPE": "Debug" }
    },
    {
      "name": "x86-release",
      "displayName": "x86 Release",
      "description": "Target Windows (32-bit) with the Visual Studio development environment. (RelWithDebInfo)",
      "inherits": "windows-base",
      "cacheVariables": { "CMAKE_BUILD_TYPE": "Release" }
    }
  ]
}

另外，直接通过命令行构建时，无论是否存在该文件都可手动指定--config参数并得到预期结果。

原因分析 #

1. CMakePresets.json对构建阶段的影响
   Visual Studio 17 2022属于多配置生成器，这类生成器不需要在配置阶段指定CMAKE_BUILD_TYPE，而是在构建阶段通过--config参数切换配置。但你的预设中强行设置了CMAKE_BUILD_TYPE缓存变量，CMake会将其识别为单配置场景，导致VS Code的CMake插件不再传递--config参数。

2. VS Code与CMakePresets的交互逻辑
   VS Code的CMake插件会解析CMakePresets.json的配置：

   • 若预设包含CMAKE_BUILD_TYPE，插件判定为单配置预设，构建时直接使用该类型，不提供配置切换面板，也不会传递--config
   • 若为多配置生成器预设且未指定CMAKE_BUILD_TYPE，插件才会启用多配置模式，显示Release/Debug切换面板，并自动传递--config参数

解决方案 #

方案1：修改CMakePresets.json适配多配置生成器 #

移除所有预设中的CMAKE_BUILD_TYPE缓存变量，添加buildPresets字段明确指定每个构建对应的配置，让VS Code自动传递--config参数：

{
  "version": 3,
  "configurePresets": [
    {
      "name": "windows-base",
      "description": "Target Windows with the Visual Studio development environment.",
      "hidden": true,
      "generator": "Visual Studio 17 2022",
      "binaryDir": "${sourceDir}/out/vscode/build/${presetName}",
      "installDir": "${sourceDir}/out/vscode/install/${presetName}",
      "cacheVariables": {
        "gtest_force_shared_crt": {
          "type": "BOOL",
          "value":  "ON"
        }
      },
      "condition": {
        "type": "equals",
        "lhs": "${hostSystemName}",
        "rhs": "Windows"
      }
    },
    {
      "name": "x64",
      "displayName": "x64",
      "description": "Target Windows (64-bit) with the Visual Studio development environment.",
      "inherits": "windows-base",
      "architecture": {
        "value": "x64",
        "strategy": "external"
      }
    },
    {
      "name": "x86",
      "displayName": "x86",
      "description": "Target Windows (32-bit) with the Visual Studio development environment.",
      "inherits": "windows-base",
      "architecture": {
        "value": "x86",
        "strategy": "external"
      }
    }
  ],
  "buildPresets": [
    {
      "name": "x64-debug",
      "displayName": "x64 Debug",
      "configurePreset": "x64",
      "configuration": "Debug"
    },
    {
      "name": "x64-release",
      "displayName": "x64 Release",
      "configurePreset": "x64",
      "configuration": "Release"
    },
    {
      "name": "x86-debug",
      "displayName": "x86 Debug",
      "configurePreset": "x86",
      "configuration": "Debug"
    },
    {
      "name": "x86-release",
      "displayName": "x86 Release",
      "configurePreset": "x86",
      "configuration": "Release"
    }
  ]
}

• buildPresets明确绑定了配置与架构预设，VS Code会识别这些预设并在构建时自动传递--config参数
• 移除CMAKE_BUILD_TYPE后，多配置生成器会正常管理不同配置的输出目录

方案2：强制VS Code传递--config参数 #

若不想修改预设，可通过VS Code设置强制插件传递参数：

1. 打开VS Code设置（快捷键Ctrl+,）
2. 搜索cmake.buildArgs
3. 添加--config ${cmake.buildType}到构建参数列表中
4. 这样无论预设如何，构建时都会自动传递当前选中的配置参数

补充说明 #

• 多配置生成器（如Visual Studio、Xcode）与单配置生成器（如Makefile）的核心区别：前者在配置阶段生成所有配置的构建文件，构建阶段指定具体配置；后者在配置阶段就确定构建类型，无法切换
• CMakePresets.json不仅作用于配置阶段，还会影响构建阶段的行为——VS Code会根据预设设置判断场景类型，进而调整构建逻辑

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