CMake使用-G Xcode生成项目时CXX_CLANG_TIDY配置失效问题咨询

问题1答复 #

你遇到的情况不是CMake的Bug，是3.20及更早版本的CMake Xcode生成器本身未实现对CXX_CLANG_TIDY属性的支持：

• Makefile类生成器的编译命令由CMake直接生成，CMake可以直接把clang-tidy作为编译命令的前缀注入到每个源文件的编译流程中，所以配置可以正常生效。
• Xcode生成器的输出是Xcode识别的xcodeproj工程配置，Xcode原生构建链路没有和CXX_CLANG_TIDY对应的配置项，早期CMake没有做该场景下的兼容逻辑，所以配置会被直接忽略。CMake直到3.28版本才正式增加了Xcode生成器对CXX_CLANG_TIDY属性的支持，低于该版本的CMake都无法在Xcode生成器下直接使用该配置。

问题2适配方案 #

有三种可行的适配方案，可根据你的使用场景选择：

方案1：使用编译数据库单独执行clang-tidy #

这是跨生成器兼容性最好的方案，无需依赖Xcode的集成能力：

1. 在CMake配置中开启编译数据库导出：

set(CMAKE_EXPORT_COMPILE_COMMANDS ON CACHE BOOL "Export compile commands" FORCE)

2. 生成Xcode工程后，根目录会生成compile_commands.json文件，直接执行以下命令即可跑全量clang-tidy检查：

clang-tidy -p compile_commands.json <你的源文件路径匹配规则>

可以把这个逻辑封装成脚本或者CI任务，不需要和Xcode构建流程绑定。

方案2：为Xcode目标添加自定义clang-tidy构建阶段 #

如果需要在Xcode点击构建时自动执行检查，可以通过CMake注入自定义构建阶段实现：

if(ENABLE_CLANG_TIDY AND CMAKE_GENERATOR STREQUAL "Xcode")
  get_target_property(TARGET_SOURCES ${my_target} SOURCES)
  foreach(SRC_FILE ${TARGET_SOURCES})
    # 只处理cpp类源文件
    if(SRC_FILE MATCHES ".*\\.(cpp|cxx|cc)$")
      add_custom_command(
        TARGET ${my_target}
        PRE_BUILD
        COMMAND ${CLANG_TIDY} ${SRC_FILE} -p ${CMAKE_BINARY_DIR}/compile_commands.json <你的clang-tidy额外参数>
        COMMENT "Running clang-tidy on ${SRC_FILE}"
      )
    endif()
  endforeach()
endif()

注意该方案需要配合编译数据库导出使用，执行顺序在编译之前，检查不通过会直接阻断构建。

方案3：升级CMake版本 #

如果你的项目可以升级CMake版本，直接升级到3.28及以上版本，即可直接使用CXX_CLANG_TIDY属性在Xcode生成器下生效，不需要修改原有配置逻辑。

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