如何在Visual Studio中以单一目标形式通过CMake执行clang-tidy？

环境信息 #

• 操作系统：Windows
• 集成开发环境：Visual Studio 2022
• LLVM：已安装
• Clang-Tidy：15.0.6
• Ninja：已安装（已添加至系统路径）

现有配置代码 #

CMakeLists.txt #

add_custom_target(tidy
    COMMAND ${CMAKE_COMMAND} -DCLANG_TIDY_EXECUTABLE=${CLANG_TIDY_EXECUTABLE} -DPROJECT_BINARY_DIR=${PROJECT_BINARY_DIR} -P ./cmake/Tidy.cmake
    WORKING_DIRECTORY ${PROJECT_SOURCE_DIR} VERBATIM)

cmake/Tidy.cmake #

find_program(CLANG_TIDY_EXECUTABLE "clang-tidy")
execute_process(COMMAND run-clang-tidy -clang-tidy-binary ${CLANG_TIDY_EXECUTABLE} -p ${PROJECT_BINARY_DIR} RESULTS_VARIABLE EXIT_CODE)
if(NOT EXIT_CODE STREQUAL 0)
    message(FATAL_ERROR "Analysis failed")
endif()

执行报错 #

Analysis failed

排查与修复步骤 #

1. 修正run-clang-tidy调用方式
   Windows下LLVM的run-clang-tidy是Python脚本（文件名为run-clang-tidy.py），直接调用run-clang-tidy可能无法正常执行。需要指定Python解释器和完整脚本路径，修改execute_process命令：

execute_process(COMMAND python "C:/Program Files/LLVM/bin/run-clang-tidy.py" -clang-tidy-binary ${CLANG_TIDY_EXECUTABLE} -p ${PROJECT_BINARY_DIR} RESULTS_VARIABLE EXIT_CODE)

注：将路径替换为你实际的LLVM安装路径下的bin目录，也可以通过find_package(LLVM REQUIRED)自动获取路径。

2. 移除重复的Clang-Tidy路径查找
   CMakeLists.txt已经传递了CLANG_TIDY_EXECUTABLE参数，Tidy.cmake中再次调用find_program会覆盖传入值，直接删除该行即可：

# 移除此行：find_program(CLANG_TIDY_EXECUTABLE "clang-tidy")

3. 确保编译数据库存在
   run-clang-tidy依赖CMake生成的compile_commands.json文件，需在项目根CMakeLists中添加配置开启生成：

set(CMAKE_EXPORT_COMPILE_COMMANDS ON)

并且确保已执行过项目构建（cmake --build <build-dir>），保证${PROJECT_BINARY_DIR}下存在该文件。

4. 修正退出码判断逻辑
   CMake的RESULTS_VARIABLE返回整数类型，用字符串比较STREQUAL会出错，修改判断条件：

if(EXIT_CODE NOT EQUAL 0)
    message(FATAL_ERROR "Analysis failed with exit code ${EXIT_CODE}")
endif()

5. 添加日志捕获排查细节
   在execute_process中加入输出和错误捕获，方便定位具体问题：

execute_process(
    COMMAND python "C:/Program Files/LLVM/bin/run-clang-tidy.py" -clang-tidy-binary ${CLANG_TIDY_EXECUTABLE} -p ${PROJECT_BINARY_DIR}
    RESULTS_VARIABLE EXIT_CODE
    OUTPUT_VARIABLE TIDY_OUTPUT
    ERROR_VARIABLE TIDY_ERROR
)
message("Clang-Tidy output: ${TIDY_OUTPUT}")
message("Clang-Tidy errors: ${TIDY_ERROR}")
if(EXIT_CODE NOT EQUAL 0)
    message(FATAL_ERROR "Analysis failed with exit code ${EXIT_CODE}")
endif()

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