CodeQLについてVisual Studio Code
ソース コードから生成されたデータベースに対して CodeQL クエリを実行して、コードベースのエラーとセキュリティの脆弱性を見つけることができます。 CodeQL code scanningの詳細については、「CodeQL を使用したコード スキャン」を参照してください。
Visual Studio Code 向けの CodeQL 拡張機能を使用すると、次のことができます。
- カスタム CodeQL クエリとサポート ライブラリを記述します。
- 大規模なオープンソースの
github/codeqlリポジトリからセキュリティ クエリを直接表示して使用します。 - 1 つ以上の CodeQL データベースに対してクエリを実行します。
- プログラム全体のデータのフローを追跡し、潜在的なセキュリティの脆弱性となる領域を強調します。
- 他のユーザーと共有するために使用または発行できるクエリまたはライブラリのすべての種類の CodeQL パックを表示、作成、編集します。
- CodeQL クエリの単体テストを実行します。
- 標準のCodeQL分析を拡張するために使用されるモデル パックCodeQL表示、作成、および編集するには、専用のエディターを使用します。
Visual Studio Code 向けの CodeQL 拡張機能では、VS Code に CodeQL のサイドバー ビューも追加されます。 これには、ローカル CodeQL データベースの一覧、現在のセッションで実行したクエリの概要、大規模な分析用のバリアント分析ビューが含まれます。
IntelliSense
この拡張機能は、.ql エディターで開くクエリ ファイル (拡張子.qll) とライブラリ ファイル (拡張子VS Code) の標準 IntelliSense 機能を提供します。 これらには次のものが含まれます。
- 構文の強調表示
- 右クリック オプション ([定義に移動] など)
- オートコンプリート候補
- ホバー情報
VS Codeの Intellisense の詳細については、ドキュメントの Visual Studio Code を参照してください。
VS Code Format Document コマンドを使用して、CodeQL スタイル ガイドに従ってコードを書式設定することもできます。
VS Code Command Palette
VS Code Command Palette から Visual Studio Code 拡張機能用の CodeQL コマンドを実行できます。 VS Code Command Paletteの詳細については、ドキュメントのVS Codeを参照してください。
データとテレメトリ
GitHubによる実行を明示的に許可することを選択した場合、GitHubは、コア開発者がVisual Studio Code拡張機能向けのCodeQLを改善するのに役立てるため、使用状況データとメトリックを収集します。 詳細については、「Visual Studio Code 用 CodeQL のテレメトリ」を参照してください。
GitHub CodeQL のライセンスについて
ライセンスに関する注意: GitHub Code Security のライセンスをお持ちでない場合、この製品をインストールすると、GitHubCodeQL の使用条件に同意したものと見なされます。
GitHub Enterprise で GitHub Advanced Security を無料で試用する方法については、GitHub Enterprise Cloud ドキュメントの「GitHub Enterprise Cloud の試用版の設定」と「GitHub Advanced Security の試用版を設定する」を参照してください。
次のステップ
CodeQL拡張機能のVisual Studio Codeをインストールする方法については、Visual Studio Code 向け CodeQL のインストール を参照してください。