查询格式

自动格式化 QL 源代码。

谁可以使用此功能？

CodeQL 可用于以下类型的仓库

此内容描述的是 CodeQL CLI 的最新版本。有关此版本的更多信息，请参阅 https://github.com/github/codeql-cli-binaries/releases。

要在早期版本中查看此命令可用的选项的详细信息，请在终端中使用 --help 选项运行该命令。

Shell

codeql query format [--output=<file>] [--in-place] [--backup=<ext>] <options>... -- <file>...

codeql query format [--output=<file>] [--in-place] [--backup=<ext>] <options>... -- <file>...

自动格式化 QL 源代码。

一个或多个要自动格式化的 .ql 或 .qll 源文件。可以指定短横线以从标准输入读取。

将格式化的 QL 代码写入此文件，而不是标准输出流。如果有多个输入，则不能给出。

用其内容的格式化版本覆盖每个输入文件。

不写入输出，如果任何输入文件与其正确的格式不同，则以状态 1 退出。除非您还提供-qq，否则会将指示哪些文件不同的消息打印到标准错误。

写入已存在的文件时，通过在其名称后附加此扩展名来将现有文件重命名为备份。如果备份文件已存在，它将被静默删除。

如果输入文件不是语法正确的 QL，则假装它已经正确格式化。（通常，此类文件会导致命令以错误消息终止）。

显示此帮助文本。

[高级] 向运行命令的 JVM 提供选项。

（请注意，包含空格的选项将无法正确处理。）

逐步增加打印的进度消息数量。

逐步减少打印的进度消息数量。

[高级] 将详细程度显式设置为错误、警告、进度、进度+、进度++、进度+++ 之一。覆盖-v 和 -q。

[高级] 将详细日志写入给定目录中的一个或多个文件，生成的名称包括时间戳和正在运行的子命令的名称。

（要写入您完全控制名称的日志文件，请改用--log-to-stderr 并按需要重定向 stderr。）

[高级] 控制磁盘上缓存数据的存储位置，这些数据将在 CLI 的多次运行之间保留，例如下载的 QL 包和已编译的查询计划。如果未显式设置，则默认为用户主目录中名为.codeql 的目录；如果它不存在，它将被创建。

自 v2.15.2 起可用。