Windows下使用Scons结合Clang -MJ选项生成compile_commands.json

我之前在Windows下用Scons构建项目时，也遇到过没法直接生成compile_commands.json的问题，最后就是靠Clang的-MJ参数解决的，刚好能匹配你的需求。下面直接给你可行的方案：

步骤1：给Scons环境添加动态的-MJ编译参数 #

你需要修改Scons的编译环境，给C++编译选项（CXXFLAGS）添加带动态目标路径的-MJ参数。Scons提供了$TARGET变量，会自动替换成当前编译的目标文件路径（比如src/core/AABB.o），我们可以利用它生成对应的.o.json文件名：

# 初始化你的Scons环境（如果还没初始化的话）
env = Environment()

# 确保使用clang++作为C++编译器（Windows下要保证clang++在PATH里）
env['CXX'] = 'clang++'

# 给每个C++编译命令添加-MJ参数，$TARGET会自动替换为当前目标文件
env.Append(CXXFLAGS=['-MJ', '$TARGET.json'])

# 如果有C语言文件，同样给CCFLAGS添加参数
# env.Append(CCFLAGS=['-MJ', '$TARGET.json'])

步骤2：正常构建静态库 #

接下来你可以按原来的代码构建静态库，现在每个源文件编译时都会自动带上-MJ参数：

library = env.StaticLibrary(target=result_path + '/' + result_name, source=sources)

比如编译src/core/AABB.cpp时，生成的命令就会和你示例的一致：

clang++ -target x86_64-pc-windows-gnu -MJ src/core/AABB.o.json -o src/core/AABB.o -c -m64 -g -O3 -std=c++14 -Wwrite-strings -I. -I/c/GodotLibraries/godot_headers -Iinclude -Iinclude/core src/core/AABB.cpp

步骤3：合并所有.o.json文件为compile_commands.json #

Clang的-MJ会为每个目标文件生成单独的json片段，我们需要把这些片段合并成标准的compile_commands.json。可以给Scons添加一个自定义目标来自动完成这件事：

# 收集所有生成的*.o.json文件（根据你的项目路径调整Glob的匹配规则）
json_files = env.Glob('**/*.o.json')

# 定义合并json文件的函数
def merge_compile_commands(target, source, env):
    import json
    compile_commands = []
    # 遍历所有json片段文件
    for json_file in source:
        with open(str(json_file), 'r', encoding='utf-8') as f:
            compile_commands.append(json.load(f))
    # 写入最终的compile_commands.json
    with open(str(target[0]), 'w', encoding='utf-8') as f:
        json.dump(compile_commands, f, indent=2)

# 添加一个自定义命令，生成compile_commands.json
compile_db = env.Command('compile_commands.json', json_files, merge_compile_commands)

# 让静态库构建依赖这个目标，这样构建完库就自动生成编译数据库
env.Depends(library, compile_db)

注意事项 #

• 要确保你的环境里能正常调用clang++，Windows下可以通过MSYS2或者Clang官方安装包配置PATH。
• 如果你的项目既有C又有C++代码，记得同时给CCFLAGS（C语言）添加-MJ参数。
• 可以用scons --verbose命令查看编译命令，确认-MJ参数是否正确添加到每个编译步骤中。
• 编译完成后，所有.o.json文件可以保留也可以删除，如果你想自动清理，可以添加一个清理目标：

  env.Clean(compile_db, json_files)
  

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