Skip to main content

CodeQL para VS Code

Você pode escrever, executar e testar CodeQL consultas dentro Visual Studio Code com a CodeQL extensão.

Quem pode usar esse recurso?

O CodeQL está disponível para os seguintes tipos de repositórios:

Sobre CodeQL para Visual Studio Code

Você pode executar CodeQL consultas em bancos de dados gerados a partir do código-fonte, a fim de encontrar erros e vulnerabilidades de segurança em uma base de código. Para obter mais informações sobre CodeQLcode scanning, consulte Verificação de código com CodeQL.

Com a extensão CodeQL para Visual Studio Code, você pode:

  • Escreva consultas personalizadas CodeQL e bibliotecas de suporte.
  • Visualize diretamente e use as CodeQL consultas de segurança do grande repositório de código aberto github/codeql.
  • Execute consultas em um ou mais CodeQL bancos de dados.
  • Acompanhar o fluxo de dados por meio de um programa, destacando áreas que são potenciais vulnerabilidades de segurança.
  • Exiba, crie e edite todos os tipos de CodeQL pacotes de consultas ou bibliotecas que você pode usar ou publicar para compartilhar com outras pessoas.
  • Execute os testes de unidade das consultas CodeQL.
  • Use um editor dedicado para exibir, criar e editar CodeQL pacotes de modelos, que são usados para estender a análise padrão CodeQL .

A extensão CodeQL para Visual Studio Code também adiciona uma visualização na barra lateral CodeQL ao VS Code. Isso contém uma lista de bancos de dados locais CodeQL , uma visão geral das consultas que você executou na sessão atual e uma exibição de análise variante para análise em grande escala.

IntelliSense

A extensão fornece recursos padrão do IntelliSense para arquivos de consulta (extensão .ql) e arquivos de biblioteca (extensão .qll) abertos no VS Code editor. Elas incluem:

  • Destaque da sintaxe
  • Opções de clique com o botão direito do mouse (como Ir para Definição)
  • Preenchimento automático de sugestões
  • Passar o mouse sobre as informações

Para obter mais informações sobre o IntelliSense em VS Code, consulte IntelliSense na documentação do Visual Studio Code.

Você também pode usar o VS Code comando Formatar Documento para formatar seu código de acordo com o CodeQL guia de estilo.

O VS Code Command Palette

Você pode executar comandos da extensão CodeQL para Visual Studio Code no VS Code Command Palette. Para obter mais informações sobre a interface do VS Code Command Paletteusuário, consulte a Interface do Usuário na VS Code documentação.

Dados e telemetria

Se você optar especificamente por permitir que GitHub faça isso, GitHub coletará dados de uso e métricas com o objetivo de ajudar os desenvolvedores principais a melhorar o CodeQL da extensão Visual Studio Code. Para obter mais informações, consulte Telemetria no CodeQL para Visual Studio Code.

Sobre a licença do GitHub CodeQL

Aviso de licença: se você não tiver uma licença da GitHub Code Security então, ao instalar este produto, estará concordando com os GitHub CodeQL Termos e Condições.

Para obter informações sobre como é possível testar o GitHub Advanced Security de forma gratuita, confira Como configurar uma avaliação gratuita do GitHub Advanced Security.

Próximas Etapas 

Para saber mais sobre como instalar a extensão CodeQL para Visual Studio Code, consulte Instalar o CodeQL para Visual Studio Code.