在使用 Bazel 构建项目时，生成 compile_commands.json 文件对于集成一些代码分析工具（如 clang-tidy 或 IDE）非常有用。以下是如何使用 bazel-compdb 生成 compile_commands.json 文件的步骤。

环境准备

首先，你需要安装 bazel-compdb 工具。你可以通过以下脚本来下载并安装 bazel-compdb：

INSTALL_DIR="/usr/local/bin"
VERSION="0.5.2"

# 下载并创建符号链接
(
  cd "${INSTALL_DIR}" \
  && curl -L "https://github.com/grailbio/bazel-compilation-database/archive/${VERSION}.tar.gz" | sudo tar -xz \
  && sudo ln -f -s "${INSTALL_DIR}/bazel-compilation-database-${VERSION}/generate.py" bazel-compdb
)

这将会在你的指定目录下创建一个名为 bazel-compdb 的可执行文件。

使用 bazel-compdb 生成 compile_commands.json

执行以下命令生成 compile_commands.json 文件：

bazel-compdb

这将在工作区的根目录下生成 compile_commands.json 文件。

如果你需要传递其他 Bazel 参数，可以使用以下命令格式：

bazel-compdb -- [additional flags for bazel]

例如，如果你想让 Bazel 在生成数据库时使用多线程构建，可以这样做：

bazel-compdb -- --jobs=4

你还可以根据需要使用以下选项来定制 bazel-compdb 的行为：

• 使用源目录：如果你希望使用源目录而不是 Bazel 执行根目录作为 Clang 命令运行的目录，可以使用 -s 选项：bazel-compdb -s
• 指定目标查询模式：你可以使用 -q 选项来限制生成的编译命令数据库只包含特定的目标，例如：bazel-compdb -q //cc/...

常见问题与解决

问题 1：当在 cc_library 中使用 ..（上级目录引用）时，可能会出现如下错误：

invalid label '../xxxc.h' in element 0 of attribute 'hdrs' in 'cc_library' rule: invalid target name '../xxx.h': target names may not contain up-level references '..'

原因：Bazel 对路径引用有严格的规范，禁止使用上级目录引用（..）以确保构建规则的可维护性。

解决方法：

• 使用 Bazel 的绝对路径（从工作区根目录开始），例如：cc_library( name = "type_basic", hdrs = [ "//xxx.h", ], )
• 通过调整项目结构或创建新的 cc_library 来组织代码，避免使用 ..。

问题 2：Build did NOT complete successfully 提示头文件缺失。

解决方法：确保所有头文件在正确的位置，并且在 BUILD 文件中被正确引用。你可以通过移动文件或调整引用来修复此问题。

总结

通过以上步骤，你应该能够成功使用 bazel-compdb 生成 compile_commands.json 文件，并解决一些常见问题。Bazel 的灵活性和强大构建系统能够很好地支持大型项目的开发，而 compile_commands.json 的生成能够帮助你在开发中更好地利用现代工具进行代码分析和调试。