Справочник по Lightbuild CLI

Lightbuild CLI – это официальный инструмент командной строки для Lightbuild. На этой странице описаны команды и параметры инструмента. Чтобы установить Lightbuild CLI, следуйте инструкциям. Информацию о распространенных задачах, таких как сборка и тестирование проекта, можно найти в статье Как собирать проекты Lightbuild из командной строки.

Синтаксис

В интерфейсе командной строки Lightbuild используется следующий синтаксис:

lightbuild [-V] [--project=path] [COMMAND]

Поддерживаются следующие глобальные параметры:

Option Описание
-V, --version Выводит информацию о версии и завершает работу.
-p, --project=path Абсолютный путь к проекту. По умолчанию используется текущий каталог, в котором должен находиться проект.

Чтобы посмотреть список доступных команд, выполните lightbuild help. Чтобы получить справку по определенной команде, выполните lightbuild help [command].

lightbuild build

Создает цель в проекте.

lightbuild build [target]
Аргумент Описание
target Целевой объект для сборки. По умолчанию выбираются все цели в текущем каталоге.

Например, чтобы собрать модуль app, выполните следующую команду:

lightbuild build app

Чтобы создать все цели в проекте, выполните следующую команду:

lightbuild build

lightbuild clean

Удаляет выходные данные сборки и кеш проекта.

lightbuild clean [target]
Аргумент Описание
target Цель, которую нужно очистить. По умолчанию выбираются все цели в текущем каталоге.

Например, чтобы удалить выходные данные сборки и кеши для всего проекта, выполните следующую команду:

lightbuild clean

lightbuild help

Показывает список доступных команд или справку по определенной команде.

lightbuild help [COMMAND]
Аргумент Описание
COMMAND Команда, для которой нужно показать справку. По умолчанию – все команды.

Чтобы посмотреть список команд, доступных для вашего проекта, выполните:

lightbuild help

Чтобы посмотреть справку по определенной команде, например query, выполните:

lightbuild help query

lightbuild query

Выводит список целей сборки, сгенерированных выходных файлов или наборов исходных файлов, которые соответствуют шаблону в модулях проекта.

lightbuild query [target-pattern] [--format=format] [--output=type]
Параметр или аргумент Описание
target-pattern Шаблон целевого пути, например ... или app.
--format=format Формат вывода, например json. По умолчанию используется таблица.
--output=type Формат выходных данных: files для расположения файлов, созданных соответствующими целями, sourcesets для их наборов исходных файлов или sourceset_types для типов их наборов исходных файлов.

Чтобы посмотреть список всех целей в проекте, выполните следующую команду:

lightbuild query ...

Чтобы вывести на печать местоположения файлов, созданных целью app, выполните следующую команду:

lightbuild query app --output=files

lightbuild resolve

Разрешает внешние зависимости проекта и генерирует офлайн-файлы блокировки зависимостей (resolved.deps) для его модулей.

lightbuild resolve [--cache=path] [--locked-dependencies] [target]
Параметр или аргумент Описание
target Модуль, для которого нужно разрешить зависимости, например app. По умолчанию выбираются все цели в текущем каталоге.
--locked-dependencies Завершает работу с ошибкой, если локальный файл блокировки зависимостей (resolved.deps) не синхронизирован.
--cache=path Каталог для хранения кеша зависимостей.

Например, чтобы сгенерировать файлы resolved.deps для всех модулей в проекте, выполните следующую команду:

lightbuild resolve

Подробные сведения о файлах resolved.deps можно найти в описании разрешенных зависимостей.

lightbuild test

Запускает тесты в проекте: локальные тесты, которые выполняются на компьютере для разработки, и инструментальные тесты, которые выполняются на подключенном устройстве или запущенном эмуляторе. Чтобы протестировать один модуль, укажите его цель, например app-core. Чтобы запустить только один тип тестов, добавьте в цель :hostTest для локальных тестов или :deviceTest для инструментальных тестов.

lightbuild test [target] [--locked-dependencies]
Параметр или аргумент Описание
target Цель для тестирования. По умолчанию используются все тесты в проекте.
--locked-dependencies Сборка не выполняется, если локальный файл блокировки зависимостей (resolved.deps) не синхронизирован.

Например, чтобы запустить все тесты в проекте, выполните следующую команду:

lightbuild test

Чтобы запустить локальные тесты в модуле app-core, выполните следующую команду:

lightbuild test app-core:hostTest

Чтобы запустить инструментальные тесты в модуле app-core на устройстве или эмуляторе, выполните следующую команду:

lightbuild test app-core:deviceTest