query format

Met automatiquement en forme le code source QL.

Qui peut utiliser cette fonctionnalité ?

CodeQL est disponible pour les types de référentiels suivants :

Référentiels publics sur GitHub.com, consultez conditions générales de CodeQL GitHub
Référentiels appartenant à l’organisation sur GitHub Enterprise Cloud avec GitHub Advanced Security activé

Dans cet article

Note

Ce contenu décrit la version la plus récente de CodeQL CLI. 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>...

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

Description

Met automatiquement en forme le code source QL.

Options

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.

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

`--common-caches=<dir>`

[Avancé] Contrôle l’emplacement des données en cache sur le disque qui persisteront entre plusieurs exécutions de l’interface CLI, telles que les packs QL téléchargés et les plans de requête compilés. S’il n’est pas défini explicitement, il s’agit par défaut d’un répertoire nommé .codeql dans le répertoire de base de l’utilisateur. S’il n’existe pas déjà, il est créé.

Disponible depuis v2.15.2.