Skip to main content
Nous publions des mises à jour fréquentes de notre documentation, et la traduction de cette page peut encore être en cours. Pour obtenir les informations les plus actuelles, consultez la documentation anglaise.

Cette version de GitHub Enterprise a été abandonnée le 2023-03-15. Aucune publication de correctifs n’est effectuée, même pour les problèmes de sécurité critiques. Pour de meilleures performances, une sécurité améliorée et de nouvelles fonctionnalités, effectuez une mise à niveau vers la dernière version de GitHub Enterprise. Pour obtenir de l’aide sur la mise à niveau, contactez le support GitHub Enterprise.

query format

Met automatiquement en forme le code source QL.

GitHub CodeQL est concédé sous licence par utilisateur lors de l’installation. Vous pouvez utiliser CodeQL uniquement pour certaines tâches soumises aux restrictions de licence. Pour plus d’informations, consultez « À propos de CodeQL CLI ».

Si vous disposez d’une licence GitHub Advanced Security, vous pouvez utiliser CodeQL pour l’analyse automatisée, l’intégration continue et la livraison continue. Pour plus d’informations, consultez « À propos de GitHub Advanced Security ».

Ce contenu décrit la version la plus récente de l’interface CLI CodeQL. Pour plus d’informations sur cette version, consultez https://github.com/github/codeql-cli-binaries/releases.

Pour voir les détails des options disponibles pour cette commande dans une version antérieure, exécutez la commande avec l’option --help dans votre terminal.

Synopsis

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

Description

Met automatiquement en forme le code source QL.

Options principales

<file>...

Un ou plusieurs fichiers sources .ql ou .qll à mettre en forme automatiquement. Un tiret peut être spécifié pour lire à partir d’une entrée standard.

-o, --output=<file>

Écrit le code QL mis en forme dans ce fichier au lieu du flux de sortie standard. Ne doit pas être donné s’il y a plusieurs entrées.

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

Remplace chaque fichier d’entrée par une version mise en forme de son contenu.

--[no-]check-only

Au lieu d’écrire une sortie, quitte avec status 1 si des fichiers d’entrée diffèrent de leur mise en forme correcte. Un message indiquant quels fichiers diffèrent est imprimé dans une erreur standard, sauf si vous donnez aussi -qq.

-b, --backup=<ext>

Lors de l’écriture d’un fichier qui existe déjà, renomme le fichier existant en sauvegarde en ajoutant cette extension à son nom. Si le fichier de sauvegarde existe déjà, il est supprimé en mode silencieux.

--no-syntax-errors

Si un fichier d’entrée n’est pas correct du point de vue de la syntaxe QL, prétend qu’il est déjà correctement mis en forme. (Généralement, un fichier comme celui-ci entraîne l’arrêt de la commande avec un message d’erreur.)

Options courantes

-h, --help

Affiche ce texte d’aide.

-J=<opt>

[Avancé] Donne une option à l’environnement JVM exécutant la commande.

(Attention, les options contenant des espaces ne sont pas gérées correctement.)

-v, --verbose

Augmente de façon incrémentielle le nombre de messages de progression affichés.

-q, --quiet

Diminue de façon incrémentielle le nombre de messages de progression affichés.

--verbosity=<level>

[Avancé] Définit explicitement le niveau de détail sur errors, warnings, progress, progress+, progress++ ou progress+++. Remplace -v et -q.

--logdir=<dir>

[Avancé] Écrit des journaux détaillés dans un ou plusieurs fichiers du répertoire donné, avec des noms générés qui incluent des horodatages et le nom de la sous-commande en cours d’exécution.

(Pour écrire un fichier journal avec un nom sur lequel vous avez un contrôle total, donnez plutôt --log-to-stderr et redirigez stderr comme vous le souhaitez.)