CMakePresets.json：在Visual Studio远程设置供应商映射中使用变量

方法1：在CMakePresets.json中直接定义自定义环境变量 #

在configurePresets的environment字段中声明自定义变量，然后在远程设置的sourceDir中通过$env{变量名}引用。示例：

{
  "configurePresets": [
    {
      "name": "your-remote-preset",
      "generator": "Ninja",
      "remoteMachineName": "你的远程机器名称",
      "vendor": {
        "microsoft.com/VisualStudioRemoteSettings/CMake/1.0": {
          "sourceDir": "$env{MY_CUSTOM_REMOTE_DIR}",
          "buildDir": "${sourceDir}/build"
        }
      },
      "environment": {
        "MY_CUSTOM_REMOTE_DIR": "/home/your-user/custom-project-dir"
      }
    }
  ]
}

这种方式的优势是变量完全由预设管理，不需要依赖系统环境，且可以针对不同预设设置不同的目录。

方法2：通过继承预设复用自定义变量 #

如果多个远程预设需要使用相同的基础目录，可以创建一个隐藏的基础预设，在其中定义环境变量，其他预设通过inherits继承，再根据需求调整sourceDir：

{
  "configurePresets": [
    {
      "name": "base-remote-config",
      "hidden": true,
      "environment": {
        "PROJECT_ROOT_REMOTE": "/opt/your-project-root"
      }
    },
    {
      "name": "remote-debug",
      "inherits": "base-remote-config",
      "generator": "Ninja",
      "remoteMachineName": "debug-server",
      "vendor": {
        "microsoft.com/VisualStudioRemoteSettings/CMake/1.0": {
          "sourceDir": "$env{PROJECT_ROOT_REMOTE}/debug-sources",
          "buildDir": "${sourceDir}/build"
        }
      },
      "cacheVariables": {
        "CMAKE_BUILD_TYPE": "Debug"
      }
    },
    {
      "name": "remote-release",
      "inherits": "base-remote-config",
      "generator": "Ninja",
      "remoteMachineName": "release-server",
      "vendor": {
        "microsoft.com/VisualStudioRemoteSettings/CMake/1.0": {
          "sourceDir": "$env{PROJECT_ROOT_REMOTE}/release-sources",
          "buildDir": "${sourceDir}/build"
        }
      },
      "cacheVariables": {
        "CMAKE_BUILD_TYPE": "Release"
      }
    }
  ]
}

方法3：结合本地环境变量动态设置远程目录 #

如果需要根据本地环境动态调整远程目录，可以在预设的environment字段中通过条件判断引用本地环境变量：

{
  "configurePresets": [
    {
      "name": "dynamic-remote-preset",
      "generator": "Ninja",
      "remoteMachineName": "your-remote-machine",
      "vendor": {
        "microsoft.com/VisualStudioRemoteSettings/CMake/1.0": {
          "sourceDir": "$env{REMOTE_SOURCE_DIR}"
        }
      },
      "environment": {
        "REMOTE_SOURCE_DIR": {
          "value": "/home/user/default-project",
          "condition": "NOT DEFINED ENV{LOCAL_PROJECT_SUBDIR}"
        },
        "REMOTE_SOURCE_DIR": {
          "value": "/home/user/projects/$env{LOCAL_PROJECT_SUBDIR}",
          "condition": "DEFINED ENV{LOCAL_PROJECT_SUBDIR}"
        }
      }
    }
  ]
}

关键说明 #

CMakeLists.txt中定义的变量无法影响CMakePresets.json的配置，因为Visual Studio会在执行CMake配置流程之前先解析CMakePresets.json，两者的执行顺序决定了CMakeLists的变量无法反向作用于预设。因此所有需要在预设中引用的变量，必须在预设本身、系统环境变量或本地环境变量中定义。

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