Skip to main content

CodeQL クエリ パックとライブラリ パックの管理

CodeQL 拡張機能を使用して、Visual Studio Code の CodeQL クエリ パックとライブラリ パックを表示、書き込み、編集できます。

Visual Studio Code の CodeQL 拡張機能を使用してパックを操作する利点

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

  • ワークスペース内の標準ライブラリをチェックアウトすることなく、CodeQL クエリ パックを書き込みます。

  • CodeQL クエリ パックの依存関係を VS Code ワークスペース内にインストールします。

  • CodeQL クエリ パックをダウンロードします。

  • CodeQL クエリ パックとそのすべての依存関係を表示します。

CodeQL クエリおよびライブラリ パックの作成と編集の詳細については、「CodeQL パックの作成と操作」を参照してください。

CodeQL クエリ パックへの依存関係のインストール

  1. VS Code で、VS Code Command Palette を開き、[CodeQL: パックの依存関係をインストールする] を実行します。

  2. 依存関係をインストールするパックを選択します。

CodeQL クエリ パックのダウンロード

  1. VS Code で、VS Code Command Palette を開き、[CodeQL: パックをダウンロードする] を実行します。

  2. すべてのコア クエリ パックをダウンロードすることも、ダウンロードする特定のパックのフル ネームを入力することもできます。 他のユーザーが作成したクエリ パックをダウンロードできます。

CodeQL クエリ パックと依存関係の表示

  1. VS Code で、CodeQL パック ディレクトリのルートにある qlpack.yml ファイルを開きます。

  2. qlpack.yml ファイルの dependencies セクションには、パックが依存しているライブラリが表示されます。

  3. 必要に応じて、VS Code の Intellisense 機能を使用できます。 たとえば、パックによって依存されているライブラリの要素にカーソルを合わせると、Visual Studio Code によって解決され、要素に関するドキュメントが表示されます。

  4. クエリの要素の完全な定義を表示するには、右クリックして [定義に移動] を選択します。

    • ライブラリ パックが同じ Visual Studio Code ワークスペース内に存在する場合は、ワークスペース内の定義にアクセスします。

    • それ以外の場合は、ダウンロードした依存関係が保存されているパッケージ キャッシュに格納されている定義が表示されます。 パッケージ キャッシュは、既定でホーム ディレクトリに格納される共有の場所です。

CodeQL モデル パックの操作

注: CodeQL モデル パックと CodeQL モデル エディターは現在ベータ版であり、変更される可能性があります。 ベータ期間中、モデル パックは C#、Java/Kotlin、Python、および Ruby 分析でのみサポートされます。

CodeQL モデル パックを使用すると、code scanning 分析を展開して、既定ではサポートされていない依存関係を含めることができます。 Visual Studio Code の CodeQL 拡張機能には、モデル パックを作成および編集するための専用エディターが含まれています。 モデル エディターの使用方法の詳細については、「CodeQL モデル エディターの使用」を参照してください。