CMAKE_EXPORT_SARIF

4.0 版本新增。

启用或禁用以 SARIF 格式输出项目相关的 CMake 诊断信息。

如果启用,CMake 将生成一个 SARIF 日志文件,其中包含 CMake 在项目运行时输出的诊断消息。默认情况下,日志文件写入 .cmake/sarif/cmake.sarif,但可以通过将命令行选项 cmake --sarif-output 设置为所需路径来更改位置。

静态分析结果交换格式 (SARIF) 是一种基于 JSON 的标准格式,用于静态分析工具(包括 CMake 等构建工具)记录和传递诊断消息。CMake 为在项目上运行 CMake 时生成的警告和错误(例如 message() 调用)生成 SARIF 日志条目。每个日志条目都包含消息、严重性以及可用的位置信息。

CMake 的 SARIF 输出示例如下

{
  "version" : "2.1.0",
  "$schema" : "https://schemastore.azurewebsites.net/schemas/json/sarif-2.1.0-rtm.4.json",
  "runs" :
  [
    {
      "tool" :
      {
        "driver" :
        {
          "name" : "CMake",
          "rules" :
          [
            {
              "id" : "CMake.Warning",
              "messageStrings" :
              {
                "default" :
                {
                  "text" : "CMake Warning: {0}"
                }
              },
              "name" : "CMake Warning"
            }
          ]
        }
      },
      "results" :
      [
        {
          "level" : "warning",
          "locations" :
          [
            {
              "physicalLocation" :
              {
                "artifactLocation" :
                {
                  "uri" : "/home/user/development/project/CMakeLists.txt"
                },
                "region" :
                {
                  "startLine" : 5
                }
              }
            }
          ],
          "message" :
          {
            "text" : "An example warning"
          },
          "ruleId" : "CMake.Warning",
          "ruleIndex" : 0
        }
      ]
    }
  ]
}