Doku · VS Code
VS-Code-Erweiterung
Sehen Sie die neuesten vetkit-Audit-Befunde für das geöffnete Repository direkt in VS Code, als Diagnosen und in einer Baumansicht „Findings“ in der vetkit-Aktivitätsleiste.
Installation
Installieren Sie vetkit (Herausgeber vetkit, ID vetkit.vetkit-vscode) aus dem Visual Studio Code Marketplace. Erforderlich ist VS Code 1.85 oder neuer.
Anmelden
Führen Sie vetkit: Sign In in der Befehlspalette aus oder klicken Sie in der Ansicht „Findings“ auf Sign in to vetkit.
- Ihr Browser öffnet die vetkit-App unter
/ide/connectund zeigt einen Einmalcode an. Prüfen Sie, ob er mit dem in VS Code angezeigten Code übereinstimmt. - Wählen Sie die Organisation und bestätigen Sie. Dafür ist mindestens die Rolle Mitglied nötig; Betrachter können nicht bestätigen.
- Die Bestätigung erstellt einen schreibgeschützten API-Schlüssel (Scopes
repos:read,audits:read,findings:read,findings:ai-fix) mit dem Namen „VS Code — Gerätename“, der nach 90 Tagen abläuft. Die Erweiterung speichert ihn im VS-Code-Secret-Storage.
Die Erweiterung warnt etwa 7 Tage vor Ablauf des Schlüssels. Läuft der Schlüssel ab oder wird er widerrufen, werden Sie aufgefordert, sich erneut anzumelden.
Alternativ führen Sie vetkit: Set API Key aus und fügen einen selbst erstellten Schlüssel ein.
Repository-Erkennung
Die Erweiterung liest die Remotes aus der .git/config des Workspaces (ohne git auszuführen), normalisiert sie zu host/owner/name und sucht sie in der angemeldeten Organisation. Bei genau einem Treffer wird dieser automatisch ausgewählt.
Andernfalls zeigt vetkit: Select Repository eine Auswahl. Sie enthält die Option Connect this repository in vetkit, die die vetkit-Seite „Repositories“ mit vorausgefülltem Repository öffnet.
Die Ergebnisse stammen aus dem letzten erfolgreichen serverseitigen Audit, nicht aus ungespeicherten Editor-Puffern. Sie werden als veraltet markiert, wenn Ihr lokaler HEAD vom geprüften Commit abweicht.
Trennen
vetkit: Sign Outwiderruft den Schlüssel auf dem Server und löscht ihn von Ihrem Gerät. Ein manuell eingefügter Schlüssel wird nur lokal vergessen, nicht widerrufen.- Sie können das Gerät auch in der vetkit-App unter Settings → Security → Connected devices widerrufen; Organisations-Admins können es unter Settings → API keys widerrufen.
- Wird ein Mitglied aus einer Organisation entfernt oder seine Rolle auf Betrachter geändert, werden seine VS-Code-Schlüssel in dieser Organisation automatisch widerrufen.
Gesendete Daten
- Bei der Anmeldung der Gerätename (Host), bereinigt und zur Benennung des API-Schlüssels verwendet.
- Das normalisierte Git-Remote (
host/owner/name) für die Repository-Suche. - Authentifizierte API-Anfragen zum Auflisten von Repositories, Audits und Befunden.
Die Erweiterung lädt nie Quellcode hoch.
Bei selbst gehosteten Installationen setzen Sie vetkit.apiUrl (HTTPS ist erforderlich, außer bei localhost). Der Schlüssel wird nur an die API gesendet, die ihn ausgestellt hat.