Skip to main content

Enterprise Server 3.21 目前作为发布候选版本提供。

适用于 VS Code 的 CodeQL

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

谁可以使用此功能?

CodeQL 可用于以下存储库类型:

关于 CodeQL 的 Visual Studio Code

可以对从源代码生成的数据库运行 CodeQL 查询,以便查找代码库中的错误和安全漏洞。 有关 CodeQLcode scanning 的详细信息,请参阅 使用 CodeQL 扫描代码

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

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

for CodeQLVisual Studio Code 扩展还会向该边栏视图添加一个 CodeQL 边栏视图 VS Code。 这包括本地 CodeQL 数据库列表、当前会话中运行的查询概述以及用于大规模分析的变体分析视图。

IntelliSense

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

  • 语法突出显示
  • 右键单击选项(如转到定义
  • 自动完成建议
  • 悬停信息

有关 VS Code 中 IntelliSense 的详细信息,请参阅 Visual Studio Code 文档中的 IntelliSense

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

VS Code Command Palette

您可以从VS Code Command Palette中运行Visual Studio Code扩展的CodeQL命令。 有关 VS Code Command Palette的详细信息,请参阅文档中的VS Code。

数据和遥测

如果你明确选择允许 GitHub 这样做,GitHub 将收集使用数据和指标,以帮助核心开发人员改进用于 Visual Studio Code 的 CodeQL 扩展。 有关详细信息,请参阅“Visual Studio Code 的 CodeQL 中的遥测”。

关于 GitHub CodeQL 许可证

许可证声明:如果没有 GitHub Code Security 许可证,则通过安装此产品,即表示你同意 GitHub CodeQL 条款和条件****。

后续步骤

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