Skip to main content

diagnostic add

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

Who can use this feature?

O CodeQL do GitHub é licenciado por usuário após a instalação. Você pode usar o CodeQL somente para determinadas tarefas sob as restrições de licença. Para obter mais informações, confira "Sobre a CLI do CodeQL".

Se você tiver uma licença do GitHub Advanced Security, poderá usar o CodeQL para análise automatizada, integração contínua e entrega contínua. Para obter mais informações, confira "Sobre a Segurança Avançada do GitHub".

Este conteúdo descreve a versão mais recente do CodeQL CLI. Para obter mais informações sobre essa versão, confira https://github.com/github/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.

Sinopse

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

Descrição

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

Disponível desde v2.12.6.

Opções

Opções principais

--markdown-message=<markdownMessage>

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

--plaintext-message=<plaintextMessage>

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.

--severity=<severity>

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

Links de ajuda relevantes para o diagnóstico.

--attributes-json=<attributesJson>

Metadados estruturados relevantes para o diagnóstico.

Opções que especificam onde salvar as informações de diagnóstico

Exatamente uma dessas opções precisa ser fornecida.

--diagnostic-dir=<diagnosticDir>

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

Opções que indicam onde a mensagem de diagnóstico pode ser exibida

--ready-for-status-page

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

--ready-for-cli-summary-table

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

Opções que descrevem a origem do diagnóstico

--source-id=<id>

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

--source-name=<name>

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

--extractor-name=<extractorName>

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

Opções que descrevem o local do diagnóstico

--file-path=<file>

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

--start-line=<startLine>

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

--start-column=<startColumn>

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

--end-line=<endLine>

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

--end-column=<endColumn>

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

Opções comuns

-h, --help

Mostre este texto de ajuda.

-J=<opt>

[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.)

-v, --verbose

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

-q, --quiet

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

--verbosity=<level>

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

--logdir=<dir>

[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.)

--common-caches=<dir>

[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.