Informations sur les paramètres dans CodeQL pour l’extension Visual Studio Code
Vous pouvez modifier de nombreux paramètres pour les données CodeQL pour l’extension de Visual Studio Code, notamment :
- La version des CodeQL CLI que l’extension utilise.
- Comment l’extension affiche les requêtes précédentes.
- Comment l’extension exécute des requêtes.
Modifier les paramètres
-
Ouvrez la vue « Extensions » et cliquez avec le bouton droit sur CodeQL, puis cliquez sur Paramètres de l’extension.
-
Dans la fenêtre Paramètres, modifiez les paramètres comme vous le souhaitez. Les paramètres sont enregistrés automatiquement.
Remarque : Vous pouvez également modifier les paramètres au format JSON en ouvrant leVS Code Command Palette et en sélectionnant Préférences : Ouvrir l’utilisateur Paramètres (JSON).
Choix d’une version de CodeQL CLI
Pour remplacer le comportement par défaut et utiliser une version spécifique de CodeQL CLI, vous pouvez spécifier le « Chemin d’accès exécutable » CodeQL CLI dans les paramètres d’extension, puis le pointer vers votre copie existante de CodeQL CLI. Autrement dit, le fichier nommé codeql (Linux et macOS) ou codeql.exe (Windows). Pour plus d’informations sur le comportement par défaut, consultez « Configuration de l’accès à la CLI CodeQL ».
Modification des étiquettes des éléments d’historique des requêtes
Le paramètre « Format » de l’historique des requêtes contrôle la façon dont l’extension répertorie les requêtes dans l’historique des requêtes. Par défaut, chaque élément a une étiquette au format suivant :
QUERY-NAME on DATABASE-NAME - QUERY-STATUS NUMBER-OF-RESULTS [QUERY-RUNTIME]
Pour remplacer l’étiquette par défaut, vous pouvez spécifier un format différent pour les éléments d’historique des requêtes.
Modification de la période de rétention pour les éléments d’historique des requêtes
Par défaut, les éléments de l’affichage « Historique des requêtes » sont conservés pendant 30 jours. Vous pouvez définir une durée de vie (TTL) différente en modifiant le paramètre « Historique des requêtes : Ttl ». Pour conserver les éléments indéfiniment, définissez la valeur sur 0.
Configuration des paramètres pour l’exécution de requêtes localement
Il existe un certain nombre de paramètres sous « Exécuter des requêtes ». Par exemple, si vos requêtes s’exécutent trop lentement et expirent fréquemment, il se peut que vous vouliez augmenter la mémoire en modifiant le paramètre « Requêtes en cours d’exécution : mémoire ».
Si vous souhaitez examiner les performances des requêtes, activez le paramètre « Requêtes en cours d’exécution : débogage » pour inclure le minutage et le nombre de tuples. Cela s’affiche ensuite dans les journaux d’activité dans l’onglet « Serveur de requêtes » CodeQL de l’affichage « Sortie ». Le nombre de tuples est utile, car il indique la taille des prédicats calculés par la requête.
Pour enregistrer les journaux du serveur de requêtes dans un emplacement personnalisé, modifiez le paramètre « Requêtes en cours d’exécution : Répertoire des journaux personnalisés ». Si vous utilisez un répertoire de journaux personnalisé, l’extension enregistre définitivement les journaux, au lieu de les supprimer automatiquement après chaque session d’espace de travail. Cela est utile si vous souhaitez examiner ces journaux pour améliorer les performances de vos requêtes.
Configuration des paramètres pour l’analyse de variantes
Il existe un certain nombre de paramètres sous « Analyse de variantes » que vous pouvez utiliser pour définir ou modifier des listes de référentiels GitHub pour l’analyse de variantes et passer à un autre référentiel de contrôleur. Pour plus d’informations sur l’objectif et les exigences d’un référentiel de contrôleur, consultez « Exécution de requêtes CodeQL à grande échelle avec l’analyse de variantes multi-référentiels ».
Vous pouvez également modifier les éléments affichés dans la vue « Référentiels d’analyse de variantes » en modifiant un fichier dans votre espace de travail Visual Studio Code appelé databases.json. Ce fichier contient une représentation JSON de tous les éléments affichés dans l’affichage. Pour ouvrir votre fichier databases.json dans une fenêtre d’éditeur, cliquez sur l’icône { } en haut à droite de la vue « Référentiels d’analyse de variantes ». Vous pouvez ensuite voir une représentation structurée des référentiels, des organisations et des listes dans votre affichage. Par exemple :
{
"version": 1,
"databases": {
"variantAnalysis": {
"repositoryLists": [
{
"name": "My favorite JavaScript repos",
"repositories": [
"facebook/react",
"babel/babel",
"angular/angular"
]
}
],
"owners": [
"microsoft"
],
"repositories": [
"apache/hadoop"
]
}
},
"selected": {
"kind": "variantAnalysisSystemDefinedList",
"listName": "top_10"
}
}
Vous pouvez modifier les éléments affichés dans la vue ou ajouter de nouveaux éléments en modifiant directement ce fichier.
Configuration des paramètres pour l’ajout de bases de données
Pour ajouter automatiquement des dossiers sources de base de données à votre espace de travail, vous pouvez activer le paramètre « Ajout de bases de données : Ajouter une source de base de données à l’espace de travail ».
Ce paramètre est désactivé par défaut. Vous pouvez activer le paramètre si vous parcourez régulièrement le code source des bases de données (par exemple, pour afficher l’arborescence de syntaxe abstraite du code). Pour plus d’informations, consultez « Exploration de la structure de votre code source ».
Si vous êtes dans un espace de travail à dossier unique, l’ajout de dossiers sources de base de données entraîne le rechargement de l’espace de travail en tant qu’espace de travail multi-racine. Cela peut entraîner la réinitialisation de l’historique des requêtes et des listes de bases de données.
Avant d’activer ce paramètre, nous vous recommandons d’enregistrer votre espace de travail en tant qu’espace de travail multi-racine. Pour plus d’informations, consultez Espaces de travail multiracines dans la documentation Visual Studio Code.
Configuration des paramètres pour le test des requêtes localement
Pour augmenter le nombre de threads utilisés pour les requêtes de test, vous pouvez mettre à jour le paramètre « Tests en cours d’exécution : nombre de threads ».
Pour passer des arguments supplémentaires à CodeQL CLI lors de l’exécution de tests, vous pouvez mettre à jour le paramètre « Tests en cours d’exécution : arguments de test supplémentaires ». Pour plus d’informations sur les arguments disponibles, consultez « test run ».
Configuration des paramètres pour la télémétrie et la collecte de données
Vous pouvez configurer si l’extension CodeQL collecte les données de télémétrie. Elle est désactivée par défaut. Pour plus d’informations, consultez « Télémétrie dans CodeQL pour Visual Studio Code ».
Pour aller plus loin
- Paramètres utilisateur et espace de travail dans la documentation Visual Studio Code