VS Code Extension
Guides
Extension VS Code
Analysez votre espace de travail depuis VS Code. Les résultats s'affichent dans l'éditeur, le panneau Problems et la barre latérale Scanverra, et votre code ne quitte jamais votre machine.
Installation
L'extension est publiée sur le Visual Studio Marketplace sous le nom Scanverra.
- Ouvrez la vue Extensions (Ctrl+Maj+X, ou Cmd+Shift+X sur macOS).
- Cherchez Scanverra et cliquez sur Installer.
- Une icône de bouclier apparaît dans la barre d'activité. C'est la vue Scanverra.
Ou collez ceci dans Quick Open (Ctrl+P, ou Cmd+P sur macOS)
ext install scanverra.scanverra-vscode
Connexion
Les analyses nécessitent une clé API Scanverra. Créez-en une dans votre tableau de bord, sous API Keys.
- Ouvrez la vue Scanverra. Si vous n'êtes pas connecté, une carte de connexion s'affiche.
- Collez votre clé API et cliquez sur Save API key. La clé est vérifiée auprès de Scanverra avant d'être enregistrée.
- Vous pouvez aussi lancer Scanverra: Log In with API Key depuis la palette de commandes.
L'extension et la CLI Scanverra utilisent la même connexion enregistrée. Si vous avez déjà lancé scanverra login, l'extension est connectée aussi, et vous connecter depuis VS Code connecte également la CLI.
Cliquez sur Log out dans la vue Scanverra, ou lancez Scanverra: Log Out. La clé enregistrée est supprimée pour l'extension et la CLI sur cette machine.
Analyser votre espace de travail
- Ouvrez un dossier dans VS Code.
- Cliquez sur Scan Workspace dans la vue Scanverra, sur le bouclier de la barre d'état, ou lancez Scanverra: Scan Workspace.
- Les résultats apparaissent soulignés dans l'éditeur et dans le panneau Problems, et sont groupés par fichier dans la barre latérale.
- Affinez la liste avec les filtres de gravité et la recherche, puis cliquez sur View pour aller au résultat ou sur Fix pour lire la correction proposée.
- Cliquez sur Clear pour effacer les résultats.
Comment ça marche
Diagnostics dans le code
Chaque résultat est affiché sur sa ligne dans l'éditeur et listé dans le panneau Problems.
Barre latérale de tri
Score, quality gate, filtres de gravité, résultats par fichier, et vulnérabilités des dépendances dans un onglet séparé.
Analyse en local
Le même moteur que la CLI. Les fichiers sont lus et vérifiés sur votre propre machine.
Garde la dernière analyse
Les résultats sont conservés par espace de travail, ils sont toujours là après un redémarrage de VS Code.
Commandes
Toutes les commandes sont disponibles dans la palette de commandes (Ctrl+Maj+P, ou Cmd+Shift+P sur macOS).
| Commande | Description |
|---|---|
Scanverra: Scan Workspace | Analyser le dossier ouvert et afficher les résultats |
Scanverra: Clear Scan Results | Retirer les résultats de l'éditeur et de la barre latérale |
Scanverra: Open Full View | Ouvrir les résultats dans un onglet d'éditeur complet |
Scanverra: Log In with API Key | Coller et vérifier une clé API |
Scanverra: Get an API Key | Ouvrir la page API Keys dans le navigateur |
Scanverra: Log Out | Supprimer la clé API enregistrée |
Ce qui quitte votre machine
L'extension télécharge les règles signées depuis Scanverra, les vérifie et exécute chaque contrôle sur votre machine. Elle n'envoie jamais vos fichiers, les lignes de code détectées ni de rapport. Seule la clé API est envoyée, pour vérifier votre compte et votre forfait.
Limites actuelles
- Les analyses se lancent à la demande. L'analyse à l'enregistrement n'existe pas encore.
- Les résultats sont surlignés sur toute la ligne, pas sur une colonne précise.
- Dans un espace de travail multi-racine, seul le premier dossier est analysé.
Dépannage
| Message | Que faire |
|---|---|
Log in to Scanverra | Collez une clé API dans la vue Scanverra, ou lancez Scanverra: Log In with API Key |
That API key was rejected | La clé est incorrecte ou a été révoquée. Créez-en une nouvelle sous API Keys |
Your saved API key was rejected | La clé enregistrée ne fonctionne plus. Collez-en une nouvelle dans la carte de connexion |
Requires a Pro, Team or Enterprise plan | Passez à un forfait supérieur, puis relancez l'analyse |
Open a folder to scan | Ouvrez un dossier via Fichier > Ouvrir le dossier, puis lancez l'analyse |
No scannable files found | Vérifiez le dossier et votre .gitignore ou .scanverraignore |
Prêt à analyser depuis votre éditeur ?
Créez une clé API, installez l'extension et lancez votre première analyse.