Referência da CLI do Lightbuild

A CLI do Lightbuild é a ferramenta de linha de comando oficial do Lightbuild. Nesta página, descrevemos os comandos e as opções dele. Para instalar a CLI do Lightbuild, consulte Instalar a CLI do Lightbuild. Para tarefas comuns, como criar e testar seu projeto, consulte Criar projetos do Lightbuild na linha de comando.

Sintaxe

A CLI do Lightbuild usa a seguinte sintaxe:

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

Ele é compatível com as seguintes opções globais:

Opção Descrição
-V, --version Imprime informações de versão e sai.
-p, --project=path O caminho absoluto para seu projeto. O padrão é o diretório atual, que precisa conter um projeto.

Para listar os comandos disponíveis, execute lightbuild help. Para receber ajuda sobre um comando específico, execute lightbuild help [command].

lightbuild build

Cria um destino no seu projeto.

lightbuild build [target]
Argumento Descrição
target O destino a ser criado. O padrão são todos os destinos no diretório atual.

Por exemplo, para criar o módulo app, execute:

lightbuild build app

Para criar todos os destinos no projeto, execute:

lightbuild build

lightbuild clean

Remove a saída de build e os caches do projeto.

lightbuild clean [target]
Argumento Descrição
target O destino a ser limpo. O padrão são todos os destinos no diretório atual.

Por exemplo, para remover a saída do build e os caches de todo o projeto, execute:

lightbuild clean

lightbuild help

Lista os comandos disponíveis ou mostra a ajuda de um comando específico.

lightbuild help [COMMAND]
Argumento Descrição
COMMAND O comando para mostrar a ajuda. O padrão é todos os comandos.

Para listar os comandos disponíveis para seu projeto, execute:

lightbuild help

Para mostrar a ajuda de um comando específico, como query, execute:

lightbuild help query

lightbuild query

Lista os destinos de build, os arquivos de saída gerados ou os conjuntos de origem que correspondem a um padrão nos módulos do projeto.

lightbuild query [target-pattern] [--format=format] [--output=type]
Opção ou argumento Descrição
target-pattern O padrão do caminho de destino, por exemplo, ... ou app.
--format=format O formato de saída, por exemplo, json. O padrão é uma tabela.
--output=type O formato da saída: files para os locais dos arquivos produzidos pelos destinos correspondentes, sourcesets para os conjuntos de origem ou sourceset_types para os tipos de conjuntos de origem.

Para listar todos os destinos no projeto, execute:

lightbuild query ...

Para mostrar os locais dos arquivos produzidos pelo destino app, execute:

lightbuild query app --output=files

lightbuild resolve

Resolve as dependências externas do projeto e gera os arquivos de bloqueio de dependência off-line (resolved.deps) para os módulos.

lightbuild resolve [--cache=path] [--locked-dependencies] [target]
Opção ou argumento Descrição
target O módulo para resolver dependências, por exemplo, app. O padrão são todos os destinos no diretório atual.
--locked-dependencies Sai com um erro se o arquivo de bloqueio de dependência local (resolved.deps) estiver dessincronizado.
--cache=path O diretório em que o cache de dependências será armazenado.

Por exemplo, para gerar os arquivos resolved.deps para todos os módulos do seu projeto, execute:

lightbuild resolve

Para mais informações sobre arquivos resolved.deps, consulte Dependências resolvidas.

lightbuild test

Executa os testes no seu projeto: testes locais, que são executados na sua máquina de desenvolvimento, e testes de instrumentação, que são executados em um dispositivo conectado ou em um emulador em execução. Para testar um módulo, especifique o destino dele, como app-core. Para executar apenas um tipo de teste, adicione :hostTest para testes locais ou :deviceTest para testes de instrumentação ao destino.

lightbuild test [target] [--locked-dependencies]
Opção ou argumento Descrição
target O destino a ser testado. O padrão são todos os testes no projeto.
--locked-dependencies Falha no build se o arquivo de bloqueio de dependência local (resolved.deps) estiver fora de sincronia.

Por exemplo, para executar todos os testes no seu projeto, execute:

lightbuild test

Para executar os testes locais no módulo app-core, execute:

lightbuild test app-core:hostTest

Para executar os testes de instrumentação no módulo app-core em um dispositivo ou emulador, execute:

lightbuild test app-core:deviceTest