diagnostic add

Quem pode usar esse recurso?

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

  • Repositórios pertencentes à organização com o Code Security habilitado

Neste artigo

Observação

Este conteúdo descreve a versão mais recente do CodeQL CLI. Para obter mais informações sobre essa versão, confira https://.com//codeql-cli-binaries/releases.

Para ver os detalhes das opções disponíveis para esse comando em uma versão anterior, execute o comando com a opção --help no terminal.

Shell
codeql diagnostic add (--diagnostic-dir=<diagnosticDir>) --source-id=<id> --source-name=<name> <options>...

[Experimental] [Encanamento] Adicionar uma parte das informações de diagnóstico.

Disponível desde v2.12.6.

Mensagem para o diagnóstico, no formato Markdown em estilo .

Mensagem para o diagnóstico, em texto sem formatação. Essa opção só deverá ser usada quando preencher uma mensagem markdown com --markdown-message não for prático.

Severidade do diagnóstico. Pode ser "error", "warning" ou "note".

Links de ajuda relevantes para o diagnóstico.

Metadados estruturados relevantes para o diagnóstico.

Exatamente uma dessas opções precisa ser fornecida.

Diretório ao qual devemos adicionar o diagnóstico.

Indicam que o diagnóstico é adequado para exibição na página status.

Indicam que o diagnóstico é adequado para exibição na tabela de resumo diagnóstico impressa por comandos como database analyze.

[Obrigatório] Um identificador para a origem desse diagnóstico.

[Obrigatório] Uma descrição legível por humanos da origem desse diagnóstico.

O nome do extrator CodeQL, se esse diagnóstico foi produzido por um extrator CodeQL.

O caminho do arquivo ao qual o diagnóstico se aplica, em relação à raiz de origem.

O número de linha baseado em 1 (inclusive) em que o local do diagnóstico é iniciado.

O número de coluna baseado em 1 (inclusive) em que o local do diagnóstico é iniciado.

O número de linha baseado em 1 (inclusive) em que o local do diagnóstico termina.

O número de coluna baseado em 1 (inclusive) em que o local do diagnóstico termina.

Mostre este texto de ajuda.

[Avançado] Forneça a opção para a JVM que executa o comando.

(Use-a com cautela, pois as opções que contêm espaços não serão tratadas corretamente.)

Aumente incrementalmente o número de mensagens de progresso impressas.

Diminua incrementalmente o número de mensagens de progresso impressas.

[Avançado] Defina explicitamente o nível de detalhamento como erros, avisos, progresso, progresso+, progresso++ ou progresso+++. Substitui -v e -q.

[Avançado] Escreva logs detalhados em um ou mais arquivos no diretório fornecido, com nomes gerados que incluem carimbos de data/hora e o nome do subcomando em execução.

(Para gravar um arquivo de log com um nome sobre o qual você tem controle completo, forneça --log-to-stderr e redirecione stderr conforme desejado.)

[Avançado] Controle a localização dos dados armazenados em cache no disco que persistirão entre várias execuções da CLI, como pacotes QL baixados e planos de consulta compilada. Se não for definido explicitamente, o padrão corresponde a um diretório intitulado .codeql no diretório inicial do usuário; que será criado se ainda não existir.

Disponível desde v2.15.2.