管理 CodeQL 查询包和库包

可以使用 CodeQL 扩展在 Visual Studio Code 中查看、编写和编辑 CodeQL 查询和库包。

本文内容

使用适用于 Visual Studio Code 的 CodeQL 扩展来处理包的好处

通过适用于 Visual Studio Code 的 CodeQL 扩展，可以执行以下操作：

  • 编写 CodeQL 查询包，而无需在工作区中签出标准库。

  • 在 VS Code 工作区中安装 CodeQL 查询包的依赖项。

  • 下载 CodeQL 查询包。

  • 查看 CodeQL 查询包及其所有依赖项。

有关创建和编辑 CodeQL 查询和库包的详细信息，请参阅 创建并使用 CodeQL 包。

安装 CodeQL 查询包的依赖项

  1. 在 VS Code 中，打开 VS Code Command Palette 并运行 CodeQL：安装包依赖项。

  2. 选择要为其安装依赖项的包。

下载 CodeQL 查询包

  1. 在 VS Code 中，打开 VS Code Command Palette 并运行 CodeQL：下载包。

  2. 可以下载所有核心查询包，或输入要下载的特定包的全名。 可以下载其他用户创建的查询包。

查看 CodeQL 查询包及其依赖项

  1. 在 VS Code 中，打开任何 CodeQL 包目录的根目录中的 qlpack.yml 文件。

  2. 在 qlpack.yml 文件的 dependencies 部分中，你将看到包所依赖的库。

  3. （可选）可以使用 VS Code 的 Intellisense 功能。 例如，如果将鼠标悬停在包依赖的库中的元素上，Visual Studio Code 会解析该元素，以便你查看有关该元素的文档。

  4. 若要查看查询元素的完整定义，可以右键单击并选择“转到定义”。

    • 如果库包存在于同一 Visual Studio Code 工作区中，则会将你带到工作区中的定义。

    • 否则，你将看到存储在包缓存中的定义，其中保存了下载的依赖项。 包缓存是默认存储在主目录中的共享位置。

处理 CodeQL 模型包

Note

CodeQL 模型包和 CodeQL 模型编辑器当前为 公共预览版，可能随时更改。 模型包由 C#、Java/Kotlin、Python，以及 Ruby 分析支持。

CodeQL 模型包可用于扩展 code scanning 分析，以包含默认情况下不支持的依赖项。 Visual Studio Code 的 CodeQL 扩展包括用于创建和编辑模型包的专用编辑器。 有关使用模型编辑器的详细信息，请参阅 使用 CodeQL 模型编辑器。