Skip to main content

À propos de CodeQL pour Visual Studio Code

Vous pouvez écrire, exécuter et tester des requêtes CodeQL directement dans Visual Studio Code grâce à l’extension CodeQL.

Qui peut utiliser cette fonctionnalité ?

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

À propos de CodeQL pour Visual Studio Code

Vous pouvez exécuter des requêtes CodeQL sur des bases de données générées à partir du code source afin d’identifier des erreurs et des vulnérabilités de sécurité dans une base de code. Pour plus d’informations sur CodeQL et code scanning, consultez À propos de l’analyse du code avec CodeQL.

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

  • Écrire des requêtes CodeQL personnalisées ainsi que les bibliothèques associées.
  • Consulter et utiliser directement les requêtes de sécurité CodeQL issues du vaste référentiel open source github/codeql.
  • Exécuter des requêtes sur une ou plusieurs bases de données CodeQL.
  • Suivre les flux de données au sein d’un programme et mettre en évidence les zones présentant des vulnérabilités de sécurité potentielles.
  • Afficher, créer et modifier tous les types de packs CodeQL (requêtes ou bibliothèques) que vous pouvez utiliser ou publier pour les partager avec d’autres.
  • Exécuter des tests unitaires pour les requêtes CodeQL.
  • Utiliser un éditeur dédié pour afficher, créer et modifier des packs de modèles CodeQL, utilisés pour étendre l’analyse CodeQL standard.

L’extension CodeQL pour Visual Studio Code ajoute également une vue latérale CodeQL dans VS Code. Cette vue contient la liste des bases de données CodeQL locales, un aperçu des requêtes exécutées au cours de la session en cours, ainsi qu’une vue d’analyse par variantes pour les analyses à grande échelle.

IntelliSense

L’extension fournit les fonctionnalités IntelliSense standard pour les fichiers de requêtes (extension .ql) et les fichiers de bibliothèques (extension .qll) ouverts dans l’éditeur VS Code. Voici quelques-uns des éléments suivants :

  • Mise en surbrillance de la syntaxe
  • Des options accessibles par clic droit (comme Go To Definition)
  • Des suggestions d’autocomplétion.
  • Des informations contextuelles au survol

Pour plus d’informations sur IntelliSense dans VS Code, consultez IntelliSense dans la documentation Visual Studio Code.

Vous pouvez également utiliser la commande VS Code Format Document pour mettre en forme votre code conformément au guide de style CodeQL.

La palette de commandes VS Code Command Palette

Vous pouvez exécuter des commandes pour l’extension CodeQL pour Visual Studio Code à partir de la palette de commandes VS Code Command Palette. Pour plus d’informations sur la palette de commandes VS Code Command Palette, consultez Interface utilisateur dans la documentation VS Code.

Données et télémétrie

Si vous choisissez explicitement d’autoriser GitHub à le faire, GitHub collecte des données et des métriques d’utilisation afin d’aider les développeurs principaux à améliorer l’extension CodeQL pour Visual Studio Code. Pour plus d’informations, consultez « Télémétrie dans CodeQL pour Visual Studio Code ».

À propos de la licence GitHub CodeQL

Avis de licence : si vous ne disposez pas d’une licence pour GitHub Advanced Security, alors, en installant ce produit, vous acceptez les Conditions générales de GitHub CodeQL.

Étapes suivantes

Pour savoir comment installer l’extension CodeQL pour Visual Studio Code, consultez Installation de CodeQL pour Visual Studio Code.