CMake 不生成compile_commands.json

C++

CMake 是一种开源的跨平台构建工具，用于自动化构建和管理 C/C++ 项目。它可以根据项目的配置文件（CMakeLists.txt）生成 Makefile 或者 Visual Studio 的工程文件，从而实现项目的编译、链接和安装等操作。然而，有时在使用 CMake 进行项目构建时，可能会出现不生成 compile_commands.JSon 文件的情况。

compile_commands.JSon 是什么？

compile_commands.JSon 是一个描述编译命令的 JSON 文件，包含了每个源文件的编译选项、预处理选项和文件路径等信息。它的存在可以帮助其他工具（如代码编辑器、静态分析工具等）更好地理解和处理项目的代码。

为什么 CMake 有时不生成 compile_commands.JSon？

CMake 生成 compile_commands.JSon 的条件是需要使用 Ninja 生成构建系统，而不是默认的 Makefile。Ninja 是一个快速的构建系统，相对于 Makefile 更高效。因此，如果没有显式地指定使用 Ninja，CMake 将默认使用 Makefile，而不会生成 compile_commands.JSon。

如何让 CMake 生成 compile_commands.JSon？

要让 CMake 生成 compile_commands.JSon，可以在 CMake 构建项目时，添加参数 -G Ninja，指定使用 Ninja 生成构建系统。具体的命令如下所示：

cmake -S <源码路径> -B <构建路径> -G Ninja

案例代码：

考虑一个简单的 C++ 项目，包含两个源文件 mAIn.cpp 和 foo.cpp，它们在同一个目录下。CMakeLists.txt 配置文件如下：

cmake
cmake_minimum_required(VERSION 3.10)
project(MyProject)
add_executable(MyExecutable mAIn.cpp foo.cpp)

在项目根目录下执行以下命令：

cmake -S . -B build -G Ninja
cmake --build build

执行以上命令后，将会在 build 目录下生成 compile_commands.JSon 文件。该文件包含了编译项目所需的所有信息，可以供其他工具使用。

通过使用 -G Ninja 参数，我们可以让 CMake 生成 compile_commands.JSon 文件，以便于其他工具更好地理解和处理项目的代码。compile_commands.JSon 的存在对于项目的开发和维护非常有帮助。因此，当需要使用相关工具时，我们可以通过指定使用 Ninja 构建系统来生成 compile_commands.JSon 文件，从而提高开发效率。