設定のカスタマイズ

Visual Studio Code 拡張機能の CodeQL の設定のついて

Visual Studio Code 拡張機能の CodeQL では、次のように多数の設定を変更できます。

拡張機能が使用する CodeQL CLI のバージョン。
拡張機能による以前のクエリの表示方法。
拡張機能によるクエリの実行方法。

CodeQL 拡張機能の設定を編集する

[拡張機能] ビューを開き、CodeQL を右クリックし、[拡張機能の設定] をクリックします。
設定ウィンドウで、必要に応じて設定を編集します。新しい設定は自動的に保存されます。

Tip

または、VS Code Command Palette を開き、[Preferences: Open User Settings (JSON)] を選択して、JSON 形式で設定を編集することもできます。

CodeQL CLI のバージョンを選択する

既定の動作をオーバーライドし、特定のバージョンの CodeQL CLI を使用するには、拡張機能の設定で CodeQL CLI の "実行可能パス" を指定し、既存の CodeQL CLI のコピーを指定します。つまり、codeql (Linux と macOS)、または codeql.exe (Windows) という名前のファイルです。既定の動作について詳しくは、「CodeQL CLI へのアクセスの構成」を参照してください。

クエリ履歴項目のラベルを変更する

クエリ履歴の [書式] 設定により、拡張機能がクエリ履歴内のクエリを一覧表示するのを制御します。既定では、各項目には次の形式のラベルがあります。

QUERY-NAME on DATABASE-NAME - QUERY-STATUS NUMBER-OF-RESULTS [QUERY-RUNTIME]

既定のラベルをオーバーライドするには、クエリ履歴項目に別の形式を指定します。

クエリ履歴アイテムの保持期間の変更

既定では、[クエリ履歴] ビューの項目は 30 日間保持されます。 [クエリ履歴: TTL] 設定を変更することで、別の有効期間 (TTL) を設定できます。アイテムを無期限に保持するには、値を 0 に設定します。

クエリをローカルで実行するための設定の構成

[実行中のクエリ] には、いくつかの設定があります。たとえば、クエリの実行速度が遅すぎてタイムアウトが頻繁に発生する場合は、[実行中のクエリ: メモリ] 設定を変更してメモリを増やすことができます。

クエリのパフォーマンスを調べるには、[実行中のクエリ: デバッグ] 設定を有効にして、タイミングとタプル数を含めるようにします。そうすると、[出力] ビューの CodeQL の [クエリサーバー] タブのログに表示されます。タプル数は、クエリによって計算された述語のサイズを示すので便利です。

クエリサーバーのログをカスタムの場所に保存するには、[実行中のクエリ: カスタムログディレクトリ] 設定を編集します。カスタムログディレクトリを使用する場合、拡張機能は、各ワークスペースセッションの後にログを自動的に削除するのではなく、完全に保存します。これは、これらのログを調査してクエリのパフォーマンスを向上させる場合に便利です。

バリアント分析の設定の構成

[バリアント分析] には、バリアント分析用の GitHub リポジトリのリストを定義または編集したり、別のコントローラーリポジトリに変更したりするために使用できる設定がいくつかあります。コントローラーリポジトリの目的と要件については、「マルチリポジトリバリアント分析を使用した大規模な CodeQL クエリの実行」を参照してください。

[バリアント分析リポジトリ] ビューに表示される項目は、Visual Studio Code の databases.json というワークスペース内のファイルを編集して編集することもできます。このファイルには、ビューに表示されるすべての項目の JSON 表記が含まれています。エディターウィンドウで databases.json ファイルを開くには、[バリアント分析リポジトリ] ビューの右上にある { } アイコンをクリックします。その後、リポジトリ、組織、リストの構造化された表記をビューに表示できます。次に例を示します。

{
  "version": 1,
  "databases": {
    "variantAnalysis": {
      "repositoryLists": [
        {
          "name": "My favorite JavaScript repos",
          "repositories": [
            "facebook/react",
            "babel/babel",
            "angular/angular"
          ]
        }
      ],
      "owners": [
        "microsoft"
      ],
      "repositories": [
        "apache/hadoop"
      ]
    }
  },
  "selected": {
    "kind": "variantAnalysisSystemDefinedList",
    "listName": "top_10"
  }
}

このファイルを直接編集することで、ビューに表示される項目を変更したり、新しい項目を追加したりできます。

データベースを追加するための設定の構成

データベースソースフォルダーをワークスペースに自動的に追加するには、[データベースの追加: ワークスペースへのデータベースソースの追加] 設定を有効にします。

既定では、この設定は無効になっています。データベースのソースコードを定期的に閲覧する場合 (たとえば、コードの抽象構文ツリーを表示する場合) に、この設定を有効にすることができます。詳しくは、「ソースコードの構造の探索」を参照してください。

Note

単一フォルダーワークスペース内にある場合、データベースソースフォルダーを追加すると、ワークスペースがマルチルートワークスペースとしてリロードされます。これにより、クエリ履歴とデータベースリストがリセットされる可能性があります。

この設定を有効にする前に、ワークスペースをマルチルートワークスペースとして保存することをお勧めします。詳細については、Visual Studio Code ドキュメントの「マルチルートワークスペース」をご覧ください。

Visual Studio Code ドキュメントのユーザーとワークスペースの設定

設定のカスタマイズ

この記事の内容