Это содержимое описывает последний выпуск данных CodeQL CLI. Дополнительные сведения об этом выпуске см. в статье https://github.com/github/codeql-cli-binaries/releases.
Чтобы просмотреть сведения о параметрах, доступных для этой команды в предыдущем выпуске, выполните команду с --help
параметром в терминале.
Краткие сведения
codeql resolve files <options>... -- <dir>
codeql resolve files <options>... -- <dir>
Description
[Глубокий сантехника] Разверните набор глобов включения и исключения файлов.
Эта команда сантехники отвечает за расширение параметров командной строки вложенных команд, работающих с несколькими файлами, идентифицируемых по их путям. По умолчанию все файлы включены и поэтому выполнение этой команды без аргументов фильтра будет собирать все файлы в каталоге.
--exclude
Параметры --include
и --prune
параметры принимают шаблоны глобов, которые могут использовать следующие подстановочные знаки:
- Один символ "?" соответствует любому символу, отличному от косой черты вперед или назад;
- Один "*" соответствует любому количеству символов, отличных от косой черты вперед или назад;
- Шаблон "**" соответствует нулю или более полным компонентам каталога.
Параметры
Основные параметры
<dir>
Каталог для поиска.
--format=<fmt>
Выберите выходной формат либо (по умолчанию),_ либо text
_json
.
Параметры ограничения набора собранных файлов
--include-extension=<.ext>
Включите все файлы в дерево каталога поиска с заданным расширением. Как правило, перед расширением следует включить точку.
Например, передача --include-extension .xml
будет включать все файлы с расширением ".xml". Этот параметр несовместим с отрицающими --include
параметрами.
--include=<glob>
Включите все файлы и каталоги в дерево каталогов поиска, соответствующие заданному глобу, используя относительный путь к каждому файлу и каталогу из каталога поиска. Если глоб начинается с символа !
, вместо этого будут исключены соответствующие файлы и каталоги.
--include
параметры обрабатываются по порядку, при этом более поздние параметры переопределяют более ранние. Например, --include ** --include !sub/*.ts --include sub/main.*
будет включать sub/main.ts
(так как оно включается sub/main.*
), исключить sub/index.ts
(так как !sub/*.ts
оно исключается) и включить sub/test.js
(поскольку оно включается **
без последующего исключения).)
--also-match=<glob>
Требовать, чтобы все результаты соответствовали заданному глобу, используя относительный путь к каждому файлу и каталогу из каталога поиска. Этот параметр имеет ту же структуру и ту же интерпретацию, что --include
и указать отдельную последовательность глобов, применяемых в сочетании с --include
.
--exclude=<glob>
Исключите все файлы и каталоги, соответствующие заданному глобу, используя относительный путь к каждому файлу и каталогу из каталога поиска. Этот параметр переопределяет все параметры включения. Этот параметр несовместим с отрицающими --include
параметрами.
--prune=<glob>
Исключите все файлы и каталоги, соответствующие заданному глобу, используя относительный путь к каждому файлу и каталогу из каталога поиска. Этот параметр переопределяет все параметры включения. Этот параметр несовместим с отрицающими --include
параметрами.
--size-limit=<bytes>
Исключите все файлы, размер которых превышает заданное ограничение. Ограничение размера в байтах или в кибибайтах (KiB) с суффиксом "k", в mebibytes (MiB) с суффиксом "m" и в гибибайтах (GiB) с суффиксом "g". Этот параметр переопределяет все параметры включения.
--total-size-limit=<bytes>
Выполните выход команды с ошибкой, если общий размер всех разрешенных файлов превысит заданное ограничение. Ограничение размера в байтах или в кибибайтах (KiB) с суффиксом "k", в mebibytes (MiB) с суффиксом "m" и в гибибайтах (GiB) с суффиксом "g".
--[no-]follow-symlinks
Следуйте любым символьным ссылкам на их цели.
--[no-]find-any
Найти не более одного совпадения (в отличие от всех совпадений).
Доступно с момента v2.11.3
.
Распространенные параметры
-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
.