{"meta":{"title":"查询格式","intro":"自动设置 QL 源代码的格式。","product":"安全性和代码质量","breadcrumbs":[{"href":"/zh/code-security","title":"安全性和代码质量"},{"href":"/zh/code-security/reference","title":"Reference"},{"href":"/zh/code-security/reference/code-scanning","title":"代码扫描"},{"href":"/zh/code-security/reference/code-scanning/codeql","title":"CodeQL"},{"href":"/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual","title":"CodeQL CLI 手册"},{"href":"/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-format","title":"查询格式"}],"documentType":"article"},"body":"# 查询格式\n\n自动设置 QL 源代码的格式。\n\n> [!NOTE]\n> 此内容描述了 CodeQL CLI 的最新版本。 有关此版本的详细信息，请参阅 https://github.com/github/codeql-cli-binaries/releases 。\n>\n> 若要查看早期版本中此命令可用选项的详细信息，请在终端中使用 <span style=\"white-space: nowrap;\">`--help`</span> 选项运行命令。\n\n## 概要\n\n```shell copy\ncodeql query format [--output=<file>] [--in-place] [--backup=<ext>] <options>... -- <file>...\n```\n\n## Description\n\n自动设置 QL 源代码的格式。\n\n## 选项\n\n### 主要选项\n\n#### `<file>...`\n\n要自动设置其格式的一个或多个 `.ql` 或 `.qll` 源文件。 可以指定短划线以从标准输入进行读取。\n\n#### `-o, --output=<file>`\n\n将格式化后的 QL 代码写入此文件，而不是标准输出流。 如果有多个输入，则不得提供该选项。\n\n#### `-i, --[no-]in-place`\n\n使用每个输入文件内容的格式化版本覆盖每个输入文件。\n\n#### `--[no-]check-only`\n\n不输出内容，若任何输入文件的格式与正确格式_不一致_，则以状态码 1 退出。 除非同时提供 `-qq`，否则将输出一条指示哪些文件存在差异的标准错误消息。\n\n#### `-b, --backup=<ext>`\n\n写入已存在的文件时，请通过将此扩展名附加到其名称来将现有文件重命名为备份。 如果备份文件已存在，则会以无提示方式将其删除。\n\n#### `--no-syntax-errors`\n\n如果输入文件在语法上不是正确的 QL，请假装已正确设置其格式。 （通常此类文件会导致命令终止并显示一条错误消息）。\n\n### 常用选项\n\n#### `-h, --help`\n\n显示此帮助文本。\n\n#### `-J=<opt>`\n\n              \\[高级] 向运行命令的 JVM 提供选项。\n\n（请注意，无法正确处理包含空格的选项。）\n\n#### `-v, --verbose`\n\n以增量方式增加输出的进度消息数。\n\n#### `-q, --quiet`\n\n以增量方式减少输出的进度消息数。\n\n#### `--verbosity=<level>`\n\n              \\[高级] 明确将详细级别设置为 errors、warnings、progress、progress+、progress++、progress+++ 之一。 重写 `-v` 和 `-q`。\n\n#### `--logdir=<dir>`\n\n              \\[高级] 将详细日志写入指定目录中的一个或多个文件，生成的文件名包含时间戳和正在运行的子命令名称。\n\n（要使用可以完全控制的名称编写日志文件，请根据需要提供 `--log-to-stderr` 并重定向 stderr。）\n\n#### `--common-caches=<dir>`\n\n              \\[高级] 控制磁盘上缓存数据的位置，这些数据将在 CLI 的多次运行之间保留，例如下载的 QL 包和编译的查询计划。 如果未明确设置，则默认为用户主目录中名为 `.codeql` 的目录；如果尚不存在，则会创建该目录。\n\n自 `v2.15.2` 起可用。"}