如何在Visual Studio Code中为CMake项目添加预构建步骤

有两种常用实现方式，第一种通过CMake配置实现，通用度更高，不受IDE限制；第二种直接修改VS Code的工作区任务配置，仅适用于当前VS Code环境。

方案1：CMake内置自定义目标（推荐） #

直接在项目根目录的CMakeLists.txt中添加规则，指定编译目标依赖脚本运行步骤即可：

• 如果你只需要在脚本内容变动时才重新运行生成代码，用以下配置：

# 替换为你实际的生成代码文件路径
set(GENERATED_CPP_FILE ${CMAKE_CURRENT_SOURCE_DIR}/generated/auto_logic.cpp)

add_custom_command(
  OUTPUT ${GENERATED_CPP_FILE}
  # 替换为你的Python解释器路径和脚本路径
  COMMAND python3 ${CMAKE_CURRENT_SOURCE_DIR}/tools/generate_code.py
  # 指定依赖，仅脚本修改时才重新触发运行
  DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/tools/generate_code.py
  COMMENT "Generating C++ code from Python script..."
)

# 把生成的代码文件加入你的主目标源文件列表，此处MyApp替换为你的实际目标名
add_executable(MyApp src/main.cpp ${GENERATED_CPP_FILE})

• 如果你需要每次构建都强制运行脚本，不需要依赖检测，改用自定义目标配置：

add_custom_target(
  RunCodeGen ALL
  # 替换为你的Python解释器路径和脚本路径
  COMMAND python3 ${CMAKE_CURRENT_SOURCE_DIR}/tools/generate_code.py
  COMMENT "Force running code generation script..."
)

# 让你的主编译目标依赖该自定义目标，保证脚本运行完成后再编译，MyApp替换为你的实际目标名
add_dependencies(MyApp RunCodeGen)

配置完成后不管是用VS Code的CMake插件构建，还是命令行执行cmake构建，都会自动先运行Python脚本。

方案2：修改VS Code工作区构建任务 #

如果你不想改动CMake配置，可以直接修改VS Code的任务配置添加前置步骤：

• 打开命令面板（快捷键Ctrl+Shift+P/Cmd+Shift+P），输入Tasks: Open Workspace Tasks，选择CMake模板生成.vscode/tasks.json文件
• 按以下示例修改配置，添加Python脚本运行的前置任务：

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "run-codegen-script",
      "type": "shell",
      // Windows环境下替换为你的Python路径，比如`C:/Users/xxx/venv/Scripts/python.exe`
      "command": "python3",
      // 替换为你实际的脚本路径
      "args": ["${workspaceFolder}/tools/generate_code.py"],
      "problemMatcher": []
    },
    {
      "label": "CMake Build",
      "dependsOn": ["run-codegen-script"],
      "group": {
        "kind": "build",
        "isDefault": true
      },
      "command": "cmake",
      "args": ["--build", "${workspaceFolder}/build", "--config", "Release"],
      "problemMatcher": ["$gcc", "$msvc"]
    }
  ]
}

• 后续按默认构建快捷键Ctrl+Shift+B/Cmd+Shift+B时，VS Code会先执行Python脚本，再运行CMake构建。

提示：如果你的Python脚本使用了虚拟环境，记得把配置里的Python解释器路径替换为虚拟环境内的解释器路径，避免依赖缺失报错。

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