Test des fichiers d’aide aux requêtes

Prerequisites

Les fichiers d’aide de requête () doivent avoir des fichiers de requête () associés avec des noms de base identiques.
Les fichiers d’aide de requête doivent suivre la structure et le style standard de la documentation d’aide sur les requêtes. Pour plus d’informations, consultez le Guide de style de l’aide aux requêtes dans le dépôt CodeQL.

Pour afficher vos fichiers d’aide de requête en tant que Markdown, exécutez la commande suivante :
Shell
```
codeql generate query-help <qhelp|query|dir|suite> --format=markdown [--output=<dir|file>]
```
```
codeql generate query-help <qhelp|query|dir|suite> --format=markdown [--output=<dir|file>]
```
Pour plus d’informations sur les options disponibles pour cette commande, consultez AUTOTITLE.
Si vous recevez des messages d’avertissement, passez en revue et corrigez-les, puis réexécutez la commande. Par défaut, CodeQL CLI affiche un message d’avertissement si :
- Aucune des aides de la requête n'est valable
- Les fichiers spécifiés dans la commande n’ont pas le même nom de base qu’un fichier associé
- Les fichiers spécifiés dans la commande n’ont pas le même nom de base qu’un fichier associé
Passez en revue le markdown rendu dans votre répertoire de sortie, fichier ou terminal pour vérifier que vos fichiers apparaissent comme prévu.