# Формат запроса

Исходный код автоформата QL.

> [!NOTE]
> Это содержимое описывает последний выпуск данных CodeQL CLI. Дополнительные сведения об этом выпуске см. в статье https://github.com/github/codeql-cli-binaries/releases.
>
> Чтобы просмотреть сведения о параметрах, доступных для этой команды в предыдущем выпуске, выполните команду с <span style="white-space: nowrap;">`--help`</span> параметром в терминале.

## Synopsis

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

## Description

Исходный код автоформата QL.

## Options

### Основные параметры

#### `<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>`

              \[Дополнительно] Управляет расположением кэшированных данных на диске, которые будут сохраняться между несколькими запусками интерфейса командной строки, такими как скачанные пакеты QL и скомпилированные планы запросов. Если этот параметр не задан явным образом, по умолчанию используется каталог с именем `.codeql` в домашнем каталоге пользователя; он будет создан, если он еще не существует.

Доступно с момента `v2.15.2`.