Test des fichiers d’aide aux requêtes

Vérifiez que les fichiers d'aide de vos requêtes CodeQL sont valides en les prévisualisant au format Markdown.

Qui peut utiliser cette fonctionnalité ?

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

Dans cet article

Prerequisites

  • Les fichiers d'aide de requête .qhelp doivent avoir des fichiers de requête .ql associés ayant 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.

Aperçu de vos fichiers d’aide de requête

  1. 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>]

    Pour plus d’informations sur les options disponibles pour cette commande, consultez generate query-help.

  2. 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 :

    • L’assistance de requête n’est pas valide
    • Les fichiers .qhelp spécifiés dans la commande n’ont pas le même nom de base qu’un fichier .ql associé
    • Les fichiers .ql spécifiés dans la commande n’ont pas le même nom de base qu’un fichier .qhelp associé

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

Lectures complémentaires

  •         [Fichiers d’aide aux requêtes](https://codeql.github.com/docs/writing-codeql-queries/query-help-files/#query-help-files)

  •         [AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual/generate-query-help)