Gestion des packs de requêtes codeQL et des packs de bibliothèque

Vous pouvez afficher, écrire et modifier les packs de requêtes et de bibliothèques CodeQL dans Visual Studio Code à l’aide de l’extension CodeQL.

Dans cet article

Avantages de l’utilisation de l’extension CodeQL pour Visual Studio Code pour travailler avec des packs

Avec les CodeQL pour l’extension Visual Studio Code, vous pouvez :

  • Écrivez les packs de requêtes CodeQL sans avoir à consulter les bibliothèques standard de votre espace de travail.

  • Installez les dépendances pour les packs de requêtes CodeQL dans votre espace de travail VS Code.

  • Téléchargez des packs de requêtes CodeQL.

  • Affichez un pack de requêtes CodeQL et toutes ses dépendances.

Pour plus d’informations sur la création et la modification des packs de requêtes de bibliothèques CodeQL, consultez « Création et utilisation de packs CodeQL ».

Installation de dépendances à des packs de requêtes CodeQL

  1. Dans VS Code, ouvrez les VS Code Command Palette et exécutez CodeQL : Installer les dépendances du pack.

  2. Sélectionnez les packs dont vous souhaitez installer les dépendances.

Téléchargement et utilisation de packs de requêtes CodeQL

  1. Dans VS Code, ouvrez les VS Code Command Palette et exécutez CodeQL : Télécharger des packs.

  2. Vous pouvez télécharger tous les packs de requêtes principaux ou entrer le nom complet d’un pack spécifique à télécharger. Vous pouvez télécharger des packs de requête créés par d’autres utilisateurs.

Vue d’un pack de requête CodeQL et de ses dépendances

  1. Dans VS Code, ouvrez le fichier qlpack.yml à la racine de n’importe quel annuaire de pack CodeQL.

  2. Dans la section dependencies du fichier qlpack.yml, vous verrez les bibliothèques dont dépend le pack.

  3. De manière facultative, vous pouvez utiliser les fonctionnalités IntelliSense de VS Code. Par exemple, si vous pointez sur un élément d’une bibliothèque dont dépend le pack, Visual Studio Code le résout afin de pouvoir voir la documentation relative à l’élément.

  4. Pour afficher la définition complète d’un élément d’une requête, vous pouvez cliquer avec le bouton droit et sélectionner Atteindre la définition.

    • Si le pack de bibliothèque est présent dans le même espace de travail Visual Studio Code, vous accédez à la définition dans l’espace de travail.

    • Sinon, vous verrez la définition stockée dans votre cache de pack, où les dépendances téléchargées sont enregistrées. Le cache de pack est un emplacement partagé stocké dans votre répertoire de base par défaut.

Utilisation des packs de modèles CodeQL

Remarque : Les packs de modèle CodeQL et l’éditeur de modèle CodeQL sont actuellement en version bêta et peuvent être susceptibles d’être modifiés. Pendant la version bêta, les packs de modèles sont pris en charge uniquement par l’analyse Java/Kotlin et C#.

Les packs de modèles CodeQL peuvent être utilisés pour étendre l’analyse code scanning afin d’inclure des dépendances qui ne sont pas prises en charge par défaut. L’extension CodeQL pour Visual Studio Code inclut un éditeur dédié pour la création et la modification de packs de modèles. Pour plus d’informations sur l’éditeur de modèle, consultez « Utilisation de l’éditeur de modèle CodeQL ».