跳至主要内容

关于适用于 VS Code 的 CodeQL

您可以使用 CodeQL 扩展在 Visual Studio Code 中编写、运行和测试 CodeQL 查询。

谁可以使用此功能?

CodeQL 可用于以下存储库类型

关于适用于 Visual Studio Code 的 CodeQL

您可以对从源代码生成的数据库运行 CodeQL 查询,以便查找代码库中的错误和安全漏洞。有关 CodeQL 代码扫描的更多信息,请参阅“关于使用 CodeQL 进行代码扫描”。

使用适用于 Visual Studio Code 的 CodeQL 扩展,您可以

  • 编写自定义 CodeQL 查询和支持库。
  • 直接查看和使用来自大型开源 github/codeql 存储库的 CodeQL 安全查询。
  • 在一个或多个 CodeQL 数据库上运行查询。
  • 跟踪数据在程序中的流动,突出显示可能的安全漏洞区域。
  • 查看、创建和编辑所有类型的 CodeQL 查询或库包,您可以使用这些包或将其发布以与他人共享。
  • 运行 CodeQL 查询的单元测试。
  • 使用专用编辑器查看、创建和编辑 CodeQL 模型包,这些包用于扩展标准 CodeQL 分析。

适用于 Visual Studio Code 的 CodeQL 扩展还向 VS Code 添加了 CodeQL 侧边栏视图。其中包含本地 CodeQL 数据库列表、当前会话中已运行的查询概述以及用于大规模分析的变体分析视图。

IntelliSense

该扩展为您在 VS Code 编辑器中打开的查询文件(扩展名 .ql)和库文件(扩展名 .qll)提供了标准 IntelliSense 功能。这些功能包括

  • 语法高亮
  • 右键单击选项(例如“转到定义”)
  • 自动完成建议
  • 悬停信息

有关 VS Code 中 Intellisense 的更多信息,请参阅 Visual Studio Code 文档中的 IntelliSense

您还可以使用 VS Code 的“格式化文档”命令根据 CodeQL 样式指南 格式化您的代码。

VS Code 命令面板

您可以从 VS Code 命令面板运行适用于 Visual Studio Code 的 CodeQL 扩展的命令。有关 VS Code 命令面板的更多信息,请参阅 VS Code 文档中的“用户界面”。

数据和遥测

如果您明确选择加入以允许 GitHub 执行此操作,GitHub 将出于帮助核心开发人员改进适用于 Visual Studio Code 的 CodeQL 扩展的目的收集使用数据和指标。有关更多信息,请参阅“适用于 Visual Studio Code 的 CodeQL 中的遥测”。

关于 GitHub CodeQL 许可证

许可证声明:如果您没有 GitHub 高级安全功能的许可证,则通过安装此产品,即表示您同意 GitHub CodeQL 条款和条件

有关如何免费试用带有 GitHub 高级安全功能的 GitHub Enterprise 的信息,请参阅 GitHub Enterprise Cloud 文档中的“设置 GitHub Enterprise Cloud 试用版”和“设置 GitHub 高级安全功能试用版”。

后续步骤

要了解如何安装适用于 Visual Studio Code 的 CodeQL 扩展,请参阅“安装适用于 Visual Studio Code 的 CodeQL”。