このコンテンツでは、CodeQL CLI の最新リリースについて説明します。 このリリースについて詳しくは、 https://github.com/github/codeql-cli-binaries/releases をご覧ください。
以前のリリースの、このコマンドで使えるオプションを詳しく確認するには、ターミナルで --help オプションを指定してコマンドを実行してください。
構文
codeql query format [--output=<file>] [--in-place] [--backup=<ext>] <options>... -- <file>...
codeql query format [--output=<file>] [--in-place] [--backup=<ext>] <options>... -- <file>...
説明
QL ソース コードのオートフォーマット。
[オプション]
主なオプション
<file>...
オートフォーマットする 1 つまたは複数の .ql または .qll ソース ファイル。 標準入力から読み取るダッシュを指定できます。
-o, --output=<file>
標準出力ストリームではなく、書式設定された QL コードをこのファイルに書き込みます。 複数の入力がある場合は指定できません。
-i, --[no-]in-place
各入力ファイルを、そのコンテンツの書式設定されたバージョンで上書きします。
--[no-]check-only
入力ファイルが正しい書式と ''異なる'' 場合は、出力を書き込む代わりに、状態 1 で終了します。__ -qq も指定しない限り、どのファイルが異なるかを示すメッセージが標準エラーに出力されます。
-b, --backup=<ext>
既に存在するファイルを書き込む場合は、この拡張子をその名前に追加して、既存のファイルの名前をバックアップに変更します。 バックアップ ファイルが既に存在する場合は、自動的に削除されます。
--no-syntax-errors
入力ファイルが構文的に正しい QL でない場合は、既に正しく書式設定されていると見せかけます (通常、このようなファイルを使用すると、コマンドがエラー メッセージで終了します)。
共通オプション
-h, --help
このヘルプ テキストを表示します。
-J=<opt>
[詳細設定] コマンドを実行している JVM にオプションを指定します
(スペースを含むオプションは正しく処理されないことに注意してください)。
-v, --verbose
出力される進行状況メッセージの数を段階的に増やします。
-q, --quiet
出力される進行状況メッセージの数を段階的に減らします。
--verbosity=<level>
[詳細設定] 詳細レベルを、errors、warnings、progress、progress+、progress++、progress+++ のいずれかに明示的に設定します。 -v と -q がオーバーライドされます。
--logdir=<dir>
[詳細設定] タイムスタンプと実行中のサブコマンドの名前を含む生成された名前を使用して、指定されたディレクトリ内の 1 つまたは複数のファイルに詳細なログを書き込みます
(完全に制御できる名前でログ ファイルを書き込むには、代わりに --log-to-stderr を指定し、必要に応じて stderr をリダイレクトします)。
--common-caches=<dir>
[[詳細設定] ダウンロードした QL パックやコンパイル済みクエリ プランなど、CLI の複数の実行間に保持される、ディスク上でキャッシュされたデータの場所を制御します。 明示的に設定されない場合、デフォルトではユーザーのホーム ディレクトリに名前が付けられた .codeql ディレクトリになります。まだ存在しない場合は作成されます。
v2.15.2 以降で使用できます。