注意
此内容描述了 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>...
一个或多个 .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>
[高级] 将详细日志写入指定目录中的一个或多个文件，文件名会包含时间戳和运行的子命令名称。
（若希望自行完全控制日志文件名，请改用 --log-to-stderr 并按需重定向 stderr。）
--common-caches=<dir>
[高级] 控制磁盘上缓存数据的位置，这些数据会在 CLI 的多次运行之间保持，例如已下载的 QL 包和已编译的查询计划。如果未显式设置，则默认使用用户主目录下名为 .codeql 的目录；如该目录不存在，则会自动创建。
自 v2.15.2 起可用。