Skip to main content

CodeQL für VS-Code

Sie können CodeQL-Abfragen in Visual Studio Code mit der Erweiterung CodeQL schreiben, ausführen und testen.

Wer kann dieses Feature verwenden?

CodeQL ist für die folgenden Repositorytypen verfügbar:

Informationen CodeQL zu Visual Studio Code

Sie können CodeQLAbfragen auf Datenbanken ausführen, die aus dem Quellcode generiert wurden, um Fehler und Sicherheitslücken in einer Codebasis zu finden. Weitere Informationen CodeQLcode scanningfinden Sie unter Codeüberprüfung mit CodeQL.

Mit der Erweiterung CodeQL für Visual Studio Code können Sie:

  • Schreiben sie benutzerdefinierte CodeQL Abfragen und unterstützende Bibliotheken.
  • Sicherheitsabfragen aus dem großen Open-Source-Repository github/codeql direkt anzeigen und verwenden.
  • Führen Sie Abfragen über eine oder CodeQL mehrere Datenbanken aus.
  • Den Datenfluss über ein Programm verfolgen und Bereiche hervorheben, die potenzielle Sicherheitsrisiken darstellen.
  • Sie können alle Arten von Paketen von CodeQL Abfragen oder Bibliotheken anzeigen, erstellen und bearbeiten, die Sie für andere Personen verwenden oder veröffentlichen können.
  • Führen Sie Komponententests für CodeQL Abfragen aus.
  • Verwenden Sie einen eigenen Editor zum Anzeigen, Erstellen und Bearbeiten von CodeQL Modellpaketen, die zur Erweiterung der CodeQL Standardanalyse verwendet werden.

Die Erweiterung CodeQL für Visual Studio Code fügt VS Code außerdem eine CodeQL Seitenleistenansicht hinzu. Dies enthält eine Liste lokaler CodeQL Datenbanken, eine Übersicht über die Abfragen, die Sie in der aktuellen Sitzung ausgeführt haben, und eine Variantenanalyseansicht für eine umfangreiche Analyse.

IntelliSense

Die Erweiterung bietet Standardmäßige IntelliSense-Features für Abfragedateien (Erweiterung .ql) und Bibliotheksdateien (Erweiterung .qll), die Sie im VS Code Editor öffnen. Dazu zählen:

  • Syntaxhervorhebung
  • Rechtsklickoptionen (z. B. Gehe zu Definition)
  • AutoVervollständigen-Vorschläge
  • Hover-Informationen

Weitere Informationen zu IntelliSense in VS Code finden Sie unter IntelliSense in der Visual Studio Code-Dokumentation.

Sie können auch den VS Code Befehl "Dokument formatieren" verwenden, um Ihren Code gemäß der CodeQL Formatvorlage zu formatieren.

Der VS Code Command Palette

Sie können Befehle für die Erweiterung CodeQL für Visual Studio Code über die VS Code Command Palette ausführen. Weitere Informationen zur VS Code Command PaletteBenutzeroberfläche finden Sie in der VS Code Dokumentation.

Daten und Telemetrie

Wenn Sie dem ausdrücklich zustimmen, GitHub wird GitHub Nutzungsdaten und Metriken erfassen, um den Kernentwicklern dabei zu helfen, die CodeQL für die Erweiterung Visual Studio Code zu verbessern. Weitere Informationen findest du unter Telemetrie in CodeQL für Visual Studio Code.

Informationen zur GitHub CodeQL-Lizenz

Lizenzhinweis: Wenn du über keine Lizenz für GitHub Code Security verfügst, stimmst du bei der Installation dieses Produkts den Geschäftsbedingungen für GitHub CodeQL zu.

Nächste Schritte

Informationen zur Installation der CodeQL für Visual Studio Code-Erweiterung finden Sie unter Installieren von CodeQL für Visual Studio Code.