В этом материале описывается последний выпуск Интерфейса командной строки CodeQL. Дополнительные сведения об этом выпуске см. в разделе https://github.com/github/codeql-cli-binaries/releases.
Чтобы просмотреть сведения о параметрах, доступных для этой команды в более раннем выпуске, выполните команду с параметром в терминале --help
.
Краткий обзор
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>
[Дополнительно] Предоставьте параметр виртуальной машине Java, запустив команду .
(Остерегайтесь, что параметры, содержащие пробелы, будут обрабатываться неправильно.)
-v, --verbose
Добавочное увеличение числа выводемых сообщений о ходе выполнения.
-q, --quiet
Постепенно уменьшайте количество выводемых сообщений о ходе выполнения.
--verbosity=<level>
[Дополнительно] Явно задайте уровень детализации для одной из ошибок, предупреждений, хода выполнения, хода выполнения+, хода выполнения++, хода выполнения+++. Переопределяет -v
и -q
.
--logdir=<dir>
[Дополнительно] Запись подробных журналов в один или несколько файлов в заданном каталоге с созданными именами, включая метки времени и имя выполняющейся подкоманды.
(Чтобы записать файл журнала с именем, над которым у вас есть полный контроль, вместо этого при необходимости предоставьте --log-to-stderr
и перенаправьте stderr.)