Skip to main content
Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais atualizadas, acesse a documentação em inglês.

query format

Formate automaticamente o código-fonte QL.

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 conta do GitHub Enterprise e uma licença do GitHub Advanced Security, poderá usar o CodeQL para análise automatizada, integração contínua e entrega contínua. Você pode criar uma conta corporativa entrando em contato com a equipe de vendas. Para obter mais informações, confira "Sobre a Segurança Avançada do GitHub".

This content describes the most recent release of the CodeQL CLI. For more information about this release, see https://github.com/github/codeql-cli-binaries/releases.

To see details of the options available for this command in an earlier release, run the command with the --help option in your terminal.

Sinopse

Shell
codeql query format [--output=<file>] [--in-place] [--backup=<ext>] <options>... -- <file>...

Descrição

Formate automaticamente o código-fonte QL.

Opções principais

<file>...

Um ou mais arquivos de origem .ql ou .qll para formatação automática. Um traço pode ser especificado para leitura por meio da entrada padrão.

-o, --output=<file>

Escreva o código QL formatado nesse arquivo em vez do fluxo de saída padrão. Não deve ser fornecido se houver mais de uma entrada.

-i, --[no-]in-place

Substitua cada arquivo de entrada por uma versão formatada do respectivo conteúdo.

--[no-]check-only

Em vez de gravar a saída, sai com O status 1 se algum arquivo de entrada for diferente da formatação correta. Uma mensagem informando os arquivos diferentes será impressa no erro padrão, a menos que você também forneça -qq.

-b, --backup=<ext>

Ao gravar um arquivo que já existe, renomeie o arquivo existente para um backup acrescentando essa extensão ao nome. Se o arquivo de backup já existir, ele será excluído silenciosamente.

--no-syntax-errors

Se um arquivo de entrada não estiver sintaticamente correto com o QL, finja que ele já está formatado corretamente. (Normalmente, esse arquivo faz com que o comando seja encerrado com uma mensagem de erro).

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