跳至主要内容

关于 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 收集使用数据和指标,以帮助核心开发者改进 Visual Studio Code 的 CodeQL 扩展。欲了解更多信息,请参阅 Visual Studio Code 的 CodeQL 遥测

关于 GitHub CodeQL 许可证

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

欲了解如何免费试用 GitHub Enterprise 与 GitHub 高级安全,请参阅 GitHub Enterprise Cloud 文档中的 设置 GitHub Enterprise Cloud 试用设置 GitHub 高级安全试用

后续步骤

要了解如何安装 Visual Studio Code 的 CodeQL 扩展,请参阅 安装 Visual Studio Code 的 CodeQL

© . This site is unofficial and not affiliated with GitHub, Inc.