管理 CodeQL 查询包和库包

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

本文内容

使用 CodeQL for Visual Studio Code 扩展处理包的好处

使用 CodeQL for Visual Studio Code 扩展，您可以：

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

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

  • 下载 CodeQL 查询包。

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

有关创建和编辑 CodeQL 查询和库包的更多信息，请参阅“创建和使用 CodeQL 包”。

安装 CodeQL 查询包的依赖项

  1. 在 VS Code 中，打开 VS Code 命令面板并运行 **CodeQL: Install Pack Dependencies**。

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

下载 CodeQL 查询包

  1. 在 VS Code 中，打开 VS Code 命令面板并运行 **CodeQL: Download Packs**。

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

查看 CodeQL 查询包及其依赖项

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

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

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

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

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

    • 否则，您将看到存储在包缓存中的定义，下载的依赖项存储在此处。包缓存是一个共享位置，默认情况下存储在您的主目录中。

使用 CodeQL 模型包

注意

CodeQL 模型包和 CodeQL 模型编辑器目前处于公开预览阶段，可能会发生更改。模型包受 C#、Java/Kotlin、Python 和 Ruby 分析的支持。

CodeQL 模型包可用于扩展代码扫描分析，以包含默认情况下不支持的依赖项。CodeQL for Visual Studio Code 扩展包含一个专用的编辑器，用于创建和编辑模型包。有关使用模型编辑器的信息，请参阅“使用 CodeQL 模型编辑器”。