Note
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
codeql query format [--output=<file>] [--in-place] [--backup=<ext>] <options>... -- <file>...
codeql query format [--output=<file>] [--in-place] [--backup=<ext>] <options>... -- <file>...
Descrição
Formate automaticamente o código-fonte QL.
Opções
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.)
--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.