VS Code Extension
Anleitungen
VS-Code-Erweiterung
Scannen Sie Ihren Workspace direkt in VS Code. Befunde erscheinen im Editor, im Problems-Panel und in der Scanverra-Seitenleiste, und Ihr Code verlässt nie Ihren Rechner.
Installation
Die Erweiterung ist im Visual Studio Marketplace unter dem Namen Scanverra veröffentlicht.
- Öffnen Sie die Erweiterungsansicht (Strg+Umschalt+X, unter macOS Cmd+Shift+X).
- Suchen Sie nach Scanverra und klicken Sie auf Installieren.
- In der Aktivitätsleiste erscheint ein Schild-Symbol. Das ist die Scanverra-Ansicht.
Oder fügen Sie dies in Quick Open ein (Strg+P, unter macOS Cmd+P)
ext install scanverra.scanverra-vscode
Anmelden
Für Scans wird ein Scanverra-API-Schlüssel benötigt. Erstellen Sie einen in Ihrem Dashboard unter API Keys.
- Öffnen Sie die Scanverra-Ansicht. Wenn Sie nicht angemeldet sind, wird eine Anmeldekarte angezeigt.
- Fügen Sie Ihren API-Schlüssel ein und klicken Sie auf Save API key. Der Schlüssel wird vor dem Speichern bei Scanverra geprüft.
- Sie können auch Scanverra: Log In with API Key über die Befehlspalette ausführen.
Die Erweiterung und die Scanverra CLI nutzen dieselbe gespeicherte Anmeldung. Wenn Sie bereits scanverra login ausgeführt haben, ist auch die Erweiterung angemeldet, und eine Anmeldung in VS Code meldet auch die CLI an.
Klicken Sie in der Scanverra-Ansicht auf Log out oder führen Sie Scanverra: Log Out aus. Dadurch wird der gespeicherte Schlüssel auf diesem Rechner für Erweiterung und CLI entfernt.
Workspace scannen
- Öffnen Sie einen Ordner in VS Code.
- Klicken Sie in der Scanverra-Ansicht auf Scan Workspace, klicken Sie auf das Schild in der Statusleiste oder führen Sie Scanverra: Scan Workspace aus.
- Befunde erscheinen als Unterstreichungen im Editor und im Problems-Panel und sind in der Seitenleiste nach Datei gruppiert.
- Grenzen Sie die Liste mit den Schweregrad-Chips und dem Suchfeld ein und klicken Sie dann auf View, um zu einem Befund zu springen, oder auf Fix, um den Lösungsvorschlag zu lesen.
- Klicken Sie auf Clear, um die Ergebnisse auszublenden.
So funktioniert es
Inline-Diagnosen
Jeder Befund wird in seiner Zeile im Editor angezeigt und im Problems-Panel aufgeführt.
Seitenleiste zur Priorisierung
Score, Quality Gate, Schweregrad-Filter, Befunde nach Datei und Abhängigkeits-Schwachstellen in einem eigenen Tab.
Lokaler Scan
Dieselbe Engine wie die CLI. Dateien werden auf Ihrem eigenen Rechner gelesen und geprüft.
Merkt sich den letzten Scan
Ergebnisse werden pro Workspace gespeichert und sind auch nach einem Neustart von VS Code noch da.
Befehle
Alle Befehle sind über die Befehlspalette verfügbar (Strg+Umschalt+P, unter macOS Cmd+Shift+P).
| Befehl | Beschreibung |
|---|---|
Scanverra: Scan Workspace | Den geöffneten Ordner scannen und die Ergebnisse anzeigen |
Scanverra: Clear Scan Results | Befunde aus Editor und Seitenleiste entfernen |
Scanverra: Open Full View | Ergebnisse in einem vollständigen Editor-Tab öffnen |
Scanverra: Log In with API Key | Einen API-Schlüssel einfügen und prüfen |
Scanverra: Get an API Key | Die API-Keys-Seite im Browser öffnen |
Scanverra: Log Out | Den gespeicherten API-Schlüssel entfernen |
Was Ihren Rechner verlässt
Die Erweiterung lädt die signierten Scanner-Regeln von Scanverra herunter, prüft sie und führt jede Prüfung auf Ihrem Rechner aus. Sie lädt weder Ihre Dateien, noch gefundene Codezeilen, noch einen Bericht hoch. Nur der API-Schlüssel wird gesendet, um Konto und Plan zu prüfen.
Aktuelle Einschränkungen
- Scans laufen nur auf Anforderung. Scan-on-Save gibt es noch nicht.
- Befunde werden für die ganze Zeile markiert, nicht für eine bestimmte Spalte.
- In einem Multi-Root-Workspace wird nur der erste Ordner gescannt.
Fehlerbehebung
| Meldung | Was zu tun ist |
|---|---|
Log in to Scanverra | Fügen Sie in der Scanverra-Ansicht einen API-Schlüssel ein oder führen Sie Scanverra: Log In with API Key aus |
That API key was rejected | Der Schlüssel ist falsch oder wurde widerrufen. Erstellen Sie unter API Keys einen neuen |
Your saved API key was rejected | Der gespeicherte Schlüssel funktioniert nicht mehr. Fügen Sie in der Anmeldekarte einen neuen ein |
Requires a Pro, Team or Enterprise plan | Aktualisieren Sie Ihren Plan und scannen Sie erneut |
Open a folder to scan | Öffnen Sie einen Ordner über Datei > Ordner öffnen und scannen Sie dann |
No scannable files found | Prüfen Sie den Ordner und Ihre .gitignore oder .scanverraignore |
Bereit, direkt im Editor zu scannen?
Erstellen Sie einen API-Schlüssel, installieren Sie die Erweiterung und führen Sie Ihren ersten Scan aus.