Dokumentacja interfejsu wiersza poleceń Lightbuild

Interfejs wiersza poleceń Lightbuild to oficjalne narzędzie wiersza poleceń Lightbuild. Na tej stronie opisano polecenia i opcje tego narzędzia. Aby dowiedzieć się, jak zainstalować interfejs wiersza poleceń Lightbuild, przeczytaj artykuł o instalowaniu interfejsu wiersza poleceń Lightbuild. Informacje o typowych zadaniach, takich jak tworzenie i testowanie projektu, znajdziesz w artykule Tworzenie projektów Lightbuild z poziomu wiersza poleceń.

Składnia

Interfejs wiersza poleceń Lightbuild używa tej składni:

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

Obsługuje te opcje globalne:

Opcja Opis
-V, --version Wyświetla informacje o wersji i kończy działanie.
-p, --project=path Ścieżka bezwzględna do projektu. Domyślnie jest to bieżący katalog, który musi zawierać projekt.

Aby wyświetlić listę dostępnych poleceń, uruchom lightbuild help. Aby uzyskać pomoc dotyczącą konkretnego polecenia, uruchom lightbuild help [command].

lightbuild build

Kompiluje środowisko docelowe w projekcie.

lightbuild build [target]
Argument Opis
target Cel do skompilowania. Domyślnie są to wszystkie cele w bieżącym katalogu.

Aby na przykład utworzyć moduł app, uruchom:

lightbuild build app

Aby skompilować wszystkie cele w projekcie, uruchom:

lightbuild build

lightbuild clean

Usuwa dane wyjściowe kompilacji i pamięci podręczne projektu.

lightbuild clean [target]
Argument Opis
target Cel do wyczyszczenia. Domyślnie są to wszystkie cele w bieżącym katalogu.

Aby na przykład usunąć dane wyjściowe kompilacji i pamięć podręczną dla całego projektu, uruchom:

lightbuild clean

lightbuild help

Wyświetla listę dostępnych poleceń lub pomoc dotyczącą konkretnego polecenia.

lightbuild help [COMMAND]
Argument Opis
COMMAND Polecenie, dla którego ma zostać wyświetlona pomoc. Domyślnie wyświetlane są wszystkie polecenia.

Aby wyświetlić listę poleceń dostępnych w projekcie, uruchom:

lightbuild help

Aby wyświetlić pomoc dotyczącą konkretnego polecenia, np. query, uruchom:

lightbuild help query

lightbuild query

Wyświetla listę elementów docelowych kompilacji, wygenerowanych plików wyjściowych lub zbiorów źródeł, które pasują do wzorca w modułach projektu.

lightbuild query [target-pattern] [--format=format] [--output=type]
Opcja lub argument Opis
target-pattern Wzorzec ścieżki docelowej, na przykład ... lub app.
--format=format Format wyjściowy, na przykład json. Domyślnie jest to tabela.
--output=type Format danych wyjściowych: files dla lokalizacji plików generowanych przez pasujące cele, sourcesets dla ich zbiorów źródeł lub sourceset_types dla typów ich zbiorów źródeł.

Aby wyświetlić listę wszystkich celów w projekcie, uruchom:

lightbuild query ...

Aby wyświetlić lokalizacje plików wygenerowanych przez cel app, uruchom:

lightbuild query app --output=files

lightbuild resolve

Rozwiązuje zależności zewnętrzne projektu i generuje pliki blokady zależności offline (resolved.deps) dla jego modułów.

lightbuild resolve [--cache=path] [--locked-dependencies] [target]
Opcja lub argument Opis
target Moduł, dla którego mają zostać rozwiązane zależności, np. app. Domyślnie są to wszystkie cele w bieżącym katalogu.
--locked-dependencies Zamyka się z błędem, jeśli lokalny plik blokady zależności (resolved.deps) nie jest zsynchronizowany.
--cache=path Katalog, w którym ma być przechowywana pamięć podręczna zależności.

Aby na przykład wygenerować pliki resolved.deps dla wszystkich modułów w projekcie, uruchom:

lightbuild resolve

Więcej informacji o plikach resolved.deps znajdziesz w artykule o rozwiązanych zależnościach.

lightbuild test

Uruchamia testy w projekcie: testy lokalne, które są uruchamiane na komputerze używanym do programowania, oraz testy z instrumentacją, które są uruchamiane na połączonym urządzeniu lub działającym emulatorze. Aby przetestować jeden moduł, określ jego cel, np. app-core. Aby uruchomić tylko jeden typ testu, dodaj do celu :hostTest w przypadku testów lokalnych lub :deviceTest w przypadku testów z instrumentacją.

lightbuild test [target] [--locked-dependencies]
Opcja lub argument Opis
target Środowisko docelowe do przetestowania. Domyślnie są to wszystkie testy w projekcie.
--locked-dependencies Jeśli lokalny plik blokady zależności (resolved.deps) nie jest zsynchronizowany, kompilacja się nie powiedzie.

Aby na przykład uruchomić wszystkie testy w projekcie, wykonaj:

lightbuild test

Aby uruchomić testy lokalne w module app-core, uruchom:

lightbuild test app-core:hostTest

Aby uruchomić testy z instrumentacją w module app-core na urządzeniu lub emulatorze, uruchom:

lightbuild test app-core:deviceTest