クエリ ヘルプ ファイルのテスト

前提条件

• クエリ ヘルプ (.qhelp) ファイルには、同じベース名を持つ付随するクエリ (.ql) ファイルが必要です。
• クエリ ヘルプ ファイルは、クエリ ヘルプ ドキュメントの標準の構造とスタイルに従う必要があります。 詳細については、 リポジトリのCodeQLを参照してください。

クエリ ヘルプ ファイルのプレビュー

1. クエリ ヘルプ ファイルを Markdown としてレンダリングするには、次のコマンドを実行します。

   Shell

   codeql generate query-help <qhelp|query|dir|suite> --format=markdown [--output=<dir|file>]
   

   このコマンドで使用できるオプションについては、 クエリ ヘルプを生成する を参照してください。

2. 警告メッセージが表示された場合は、それらを確認して修正してから、コマンドを再実行します。 既定では、次の場合、 CodeQL CLI は警告メッセージを出力します。

   • クエリ ヘルプのいずれかが無効です
   • コマンドで指定された .qhelp ファイルに、添付の .ql ファイルと同じベース名がない
   • コマンドで指定された .ql ファイルに、添付の .qhelp ファイルと同じベース名がない

3. 出力ディレクトリ、ファイル、またはターミナルでレンダリングされた Markdown を確認して、ファイルが期待どおりに表示されることを確認します。

詳細については、次を参照してください。

•         [クエリ ヘルプ ファイル](https://codeql.github.com/docs/writing-codeql-queries/query-help-files/#query-help-files)
  

•         [AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual/generate-query-help)