Skip to main content

此版本的 GitHub Enterprise Server 已于以下日期停止服务 2024-07-09. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持

query format

自动设置 QL 源代码的格式。

谁可以使用此功能?

GitHub CodeQL 在安装后按用户授权。 根据许可证限制,只能将 CodeQL 用于某些任务。 有关详细信息,请参阅“关于 CodeQL CLI”。

如果你有 GitHub Advanced Security 许可证,则可以使用 CodeQL 进行自动分析、持续集成和持续交付。 有关详细信息,请参阅“关于 GitHub 高级安全性”。

本文内容

此内容描述了 CodeQL CLI 的最新版本。 有关此版本的详细信息,请参阅 https://github.com/github/codeql-cli-binaries/releases

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

摘要

Shell
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>

[高级] 将详细级别显式设置为“错误”、“警告”、“进度”、“进度+”、“进度++”、“进度+++”之一。 重写 -v-q

--logdir=<dir>

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

(若要使用可以完全控制的名称编写日志文件,请根据需要提供 --log-to-stderr 并重定向 stderr。)

--common-caches=<dir>

[高级] 控制磁盘上缓存数据的位置,此位置会在多次运行 CLI(例如下载的 QL 包和已编译查询计划)期间暂留。 如果未明确设置,则默认为用户主目录中名为 .codeql 的目录;如果尚不存在,则会创建该目录。

v2.15.2 起可用。