カスタム クエリの作成

テンプレートから作業して独自のコードを記述し、特定の言語を分析するカスタム クエリを作成できます。

この記事の内容

カスタム クエリについて

Note

カスタム クエリの作成は省略可能であり、github/codeql リポジトリには代わりに使用できる多数のクエリの例が含まれています。

特定の言語のテンプレートから新しいクエリ ファイルを作成し、その言語を分析するための標準ライブラリをインポートします。 詳細については、CodeQL ドキュメントにある CodeQL クエリに関するページを参照してください。

カスタム クエリの作成

  1. 拡張機能サイドバーで、[クエリ] ビューを開き、[クエリの作成] アイコンをクリックします。

  2. VS Code Command Palette で、クエリのターゲット言語を選択します。 既存のディレクトリにカスタム クエリを作成しないことを選択した場合、言語を選択すると、codeql-custom-queries-LANGUAGE のラベル付けされたディレクトリ (LANGUAGE が選択した言語の名前の場合) が自動生成されます。 example.ql のラベル付けされたクエリ テンプレートが、既存のディレクトリまたは自動生成されたディレクトリに追加されます。

  3. テンプレートでカスタム クエリを記述し、ファイルを保存します。 クエリが完了したら、[クエリ] ビューから実行できます。

参考資料

サポートされている言語のクエリを作成する方法については、CodeQL のドキュメントを参照してください。