Skip to main content

VS Code 用 CodeQL について

CodeQL 拡張機能を使用して、Visual Studio Code 内の CodeQL クエリを書き込み、実行、テストできます。

この機能を使用できるユーザーについて

CodeQL は、次の種類のリポジトリで使用できます:

Visual Studio Code の CodeQL について

コードベースでエラーとセキュリティの脆弱性を見つけるには、ソース コードから生成されたデータベースに対して CodeQL クエリを実行します。 CodeQL code scanning の詳細については、「CodeQL によるコード スキャンについて」を参照してください。

Visual Studio Code 拡張機能の CodeQL では、次のことができます。

  • カスタム CodeQL クエリとサポート ライブラリを記述します。
  • 大規模なオープン ソース github/codeql リポジトリから CodeQL セキュリティ クエリを直接表示して使用します。
  • 1 つ以上の CodeQL データベースに対してクエリを実行します。
  • プログラム全体のデータのフローを追跡し、潜在的なセキュリティの脆弱性となる領域を強調します。
  • 他のユーザーと共有するために使用または発行できるクエリまたはライブラリのすべての種類の CodeQL パックを表示、作成、編集します。
  • CodeQL クエリの単体テストを実行します。
  • CodeQL モデル パックを表示、作成、編集するための専用エディターを使用します。これは、標準の CodeQL 分析を拡張するために使用されます。

また、Visual Studio Code 拡張機能の CodeQL は、VS Code に CodeQL サイドバー ビューを追加します。 これには、ローカル CodeQL データベースの一覧、現在のセッションで実行したクエリの概要、大規模な分析用のバリアント分析ビューが含まれます。

IntelliSense

この拡張機能には、VS Code エディターで開くクエリ ファイル (拡張子 .ql) およびライブラリ ファイル (拡張子 .qll) 用の標準 IntelliSense 機能があります。 これらには次のものが含まれます。

  • 構文の強調表示
  • 右クリック オプション ([定義に移動] など)
  • オートコンプリート候補
  • ホバー情報

VS Code における IntelliSense に関する詳細は、Visual Studio Code ドキュメントドキュメントの「IntelliSense」をご覧ください。

VS Code [ドキュメントの書式設定] コマンドを使用し、CodeQL スタイル ガイドに従ってコードを書式設定することもできます。

VS Code Command Palette

VS Code Command Palette から Visual Studio Code 拡張機能の CodeQL 用コマンドを実行できます。 VS Code Command Palette について詳しくは、VS Code のドキュメントの「ユーザー インターフェイス」を参照してください。

データとテレメトリ

GitHub がこれを行う許可を明示的にオプトインした場合、 は、使用方法データとメトリックを収集し、コア開発者が Visual Studio Code 拡張機能の CodeQL を改善することを支援します。 詳しくは、「Visual Studio Code 用 CodeQL のテレメトリ」をご覧ください。

GitHub CodeQL のライセンスについて

ライセンスに関する注意: GitHub Code Security のライセンスをお持ちでない場合、この製品をインストールすると、GitHubCodeQL の使用条件に同意したものと見なされます。

次のステップ

Visual Studio Code 拡張機能の CodeQL をインストールする方法については、「Visual Studio Code 向け CodeQL のインストール」を参照してください。