Configurações personalizadas

Sobre as configurações na extensão do CodeQL para Visual Studio Code

Você pode alterar várias configurações para a extensão do CodeQL para Visual Studio Code, incluindo:

• Qual versão da CodeQL CLI a extensão usa.
• Como a extensão exibe consultas anteriores.
• Como a extensão executa consultas.

Como editar as configurações da extensão CodeQL

1. Abra o modo de exibição "Extensões" e clique com o botão direito do mouse em CodeQL e, em seguida, clique em Definições de Extensão.

   

2. Na janela Configurações, edite as configurações conforme desejado. As novas configurações são salvas automaticamente.

   

Escolher uma versão da CodeQL CLI

Para substituir o comportamento padrão e usar uma versão específica da CodeQL CLI, você pode especificar o "Caminho executável" da CodeQL CLI nas configurações de extensão e apontá-lo para sua cópia existente da CodeQL CLI. Ou seja, o arquivo denominado codeql (Linux e macOS), ou codeql.exe (Windows). Para obter mais informações sobre o comportamento padrão, confira Configurar o acesso à CLI do CodeQL.

Alterar os rótulos dos itens do histórico de consultas

A configuração "Formatar" do histórico de consultas controla como a extensão lista consultas no histórico de consultas. Por padrão, cada item tem um rótulo com o seguinte formato:

QUERY-NAME on DATABASE-NAME - QUERY-STATUS NUMBER-OF-RESULTS [QUERY-RUNTIME]

Para substituir o rótulo padrão, você pode especificar um formato diferente para os itens do histórico de consultas.

Alterar o período de retenção para itens do histórico de consultas

Por padrão, os itens no modo de exibição "Histórico de Consultas" são retidos por 30 dias. Você pode definir uma vida útil (TTL) diferente alterando a configuração de "Histórico de Consultas: Ttl". Para reter itens indefinidamente, defina o valor como 0.

Definir configurações para executar consultas localmente

Há várias configurações em "Consultas em Execução". Por exemplo, se as consultas forem executadas muito lentamente e atingirem o tempo limite com frequência, convém aumentar a memória alterando a configuração de "Consultas em Execução: Memória".

Se você quiser examinar o desempenho da consulta, habilite a configuração "Consultas em Execução: Depurar" para incluir contagens de tempo e tuplas. Isso será mostrado nos logs na guia "Servidor de Consulta" do CodeQL do modo de exibição "Saída". A contagem de tuplas é útil porque indica o tamanho dos predicados computados pela consulta.

Para salvar logs do servidor de consulta em um local personalizado, edite a configuração "Consultas em Execução: Diretório de Logs Personalizado". Se você usar um diretório de logs personalizado, a extensão salvará os logs permanentemente, em vez de excluí-los automaticamente após cada sessão de espaço de trabalho. Isso é útil quando você quer investigar esses logs para melhorar o desempenho de suas consultas.

Definir configurações para análise de variantes

Há várias configurações em "Análise de Variantes" que você pode usar para definir ou editar listas de repositórios do GitHub para análise de variantes e alterar para outro repositório de controlador. Para obter informações sobre a finalidade e os requisitos de um repositório de controlador, confira Executar consultas do CodeQL em escala com análise de variantes de vários repositórios.

Você também pode editar os itens mostrados no modo de exibição "Repositórios de Análise de Variantes" editando um arquivo em seu espaço de trabalho Visual Studio Code denominado databases.json. Esse arquivo contém uma representação JSON de todos os itens exibidos no modo de exibição. Para abrir o arquivo databases.json em uma janela do editor, clique no ícone { } no canto superior direito do modo de exibição "Repositórios de Análise de Variantes". Em seguida, você pode ver uma representação estruturada dos repositórios, organizações e listas em seu modo de exibição. Por exemplo:

{
  "version": 1,
  "databases": {
    "variantAnalysis": {
      "repositoryLists": [
        {
          "name": "My favorite JavaScript repos",
          "repositories": [
            "facebook/react",
            "babel/babel",
            "angular/angular"
          ]
        }
      ],
      "owners": [
        "microsoft"
      ],
      "repositories": [
        "apache/hadoop"
      ]
    }
  },
  "selected": {
    "kind": "variantAnalysisSystemDefinedList",
    "listName": "top_10"
  }
}

Você pode alterar os itens mostrados no modo de exibição ou adicionar novos itens editando diretamente esse arquivo.

Definir as configurações para adicionar bancos de dados

Para adicionar automaticamente pastas de origem de banco de dados ao seu espaço de trabalho, você pode habilitar a configuração "Adicionar Bancos de Dados: Adicionar Origem de Banco de Dados ao Espaço de Trabalho".

Essa configuração é desabilitada por padrão. Você pode querer habilitar a configuração caso procure regularmente o código-fonte dos bancos de dados (por exemplo, para exibir a árvore de sintaxe abstrata do código). Para saber mais, confira Explorar a estrutura do seu código-fonte.

Definir as configurações para testar consultas localmente

Para aumentar o número de threads usados para testar consultas, você pode atualizar a configuração "Testes em Execução: Número de Threads".

Para passar argumentos adicionais para a CodeQL CLI ao executar testes, você pode atualizar a configuração "Testes em Execução: Argumentos de Testes Adicionais". Para obter mais informações sobre os argumentos disponíveis, confira test run.

Definir as configurações para telemetria e coleta de dados

Você pode configurar se a extensão do CodeQL coleta dados telemétricos. Ele está desabilitado por padrão. Para saber mais, confira Telemetria no CodeQL para Visual Studio Code.

Como alterar a URL do GitHub usada pela extensão

Por padrão, a extensão CodeQL para Visual Studio Code está configurada para analisar os repositórios hospedados no GitHub.com. Se você usar o GitHub Enterprise Cloud com residência de dados, especifique a URL do seu site usando a configuração “URI do GitHub Enterprise”.

Como especificar a URL do GitHub nas configurações

1. Abra o modo de exibição "Extensões" e clique com o botão direito do mouse em CodeQL e, em seguida, clique em Definições de Extensão.

2. Na janela “Configurações”, role a página para baixo até encontrar as configurações de Autenticação do GitHub e insira a URL do GitHub Enterprise Cloud com residência de dados. As novas configurações são salvas automaticamente.

   

Como alternativa, você pode definir a URL no arquivo JSON no qual as configurações do CodeQL estão armazenadas.

    "github-enterprise.uri": "SUBDOMAIN.ghe.com",

Quando a extensão usa a URL do GitHub definida por você

Quando o URI da Empresa do GitHub (github-enterprise.uri) é definido, a extensão usa essa URL em:

• Solicitações para baixar bancos de dados do GitHub
• Como criar uma lista de repositórios para a análise de variantes

Leitura adicional

• Configurações de usuário e espaço de trabalho na documentação do Visual Studio Code