Documentation de référence sur la CLI Lightbuild

La CLI Lightbuild est l'outil de ligne de commande officiel pour Lightbuild. Cette page décrit ses commandes et ses options. Pour installer la CLI Lightbuild, consultez Installer la CLI Lightbuild. Pour les tâches courantes, comme la compilation et le test de votre projet, consultez Compiler des projets Lightbuild à partir de la ligne de commande.

Syntaxe

La CLI Lightbuild utilise la syntaxe suivante :

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

Il accepte les options globales suivantes :

Option Description
-V, --version Affiche les informations sur la version et quitte l'outil.
-p, --project=path Chemin absolu vers votre projet. La valeur par défaut est le répertoire actuel, qui doit contenir un projet.

Pour lister les commandes disponibles, exécutez lightbuild help. Pour obtenir de l'aide sur une commande spécifique, exécutez lightbuild help [command].

lightbuild build

Crée une cible dans votre projet.

lightbuild build [target]
Argument Description
target Cible à compiler. La valeur par défaut correspond à toutes les cibles du répertoire actuel.

Par exemple, pour compiler le module app, exécutez la commande suivante :

lightbuild build app

Pour compiler toutes les cibles de votre projet, exécutez la commande suivante :

lightbuild build

lightbuild clean

Supprime la sortie de compilation et les caches de votre projet.

lightbuild clean [target]
Argument Description
target Cible à nettoyer. La valeur par défaut correspond à toutes les cibles du répertoire actuel.

Par exemple, pour supprimer la sortie de compilation et les caches de l'ensemble de votre projet, exécutez la commande suivante :

lightbuild clean

lightbuild help

Répertorie les commandes disponibles ou affiche l'aide d'une commande spécifique.

lightbuild help [COMMAND]
Argument Description
COMMAND Commande pour laquelle afficher l'aide. Par défaut, toutes les commandes sont incluses.

Pour lister les commandes disponibles pour votre projet, exécutez la commande suivante :

lightbuild help

Pour afficher l'aide d'une commande spécifique, telle que query, exécutez la commande suivante :

lightbuild help query

lightbuild query

Répertorie les cibles de compilation, les fichiers de sortie générés ou les ensembles de sources qui correspondent à un modèle dans les modules de votre projet.

lightbuild query [target-pattern] [--format=format] [--output=type]
Option ou argument Description
target-pattern Format du chemin d'accès cible, par exemple ... ou app.
--format=format Format de sortie, par exemple json. La valeur par défaut est un tableau.
--output=type Format de la sortie : files pour les emplacements des fichiers produits par les cibles correspondantes, sourcesets pour leurs ensembles de sources ou sourceset_types pour les types de leurs ensembles de sources.

Pour lister toutes les cibles de votre projet, exécutez la commande suivante :

lightbuild query ...

Pour imprimer les emplacements des fichiers produits par la cible app, exécutez la commande suivante :

lightbuild query app --output=files

lightbuild resolve

Résout les dépendances externes de votre projet et génère les fichiers de verrouillage des dépendances hors connexion (resolved.deps) pour ses modules.

lightbuild resolve [--cache=path] [--locked-dependencies] [target]
Option ou argument Description
target Module pour lequel résoudre les dépendances, par exemple app. La valeur par défaut correspond à toutes les cibles du répertoire actuel.
--locked-dependencies Quitte avec une erreur si le fichier de verrouillage de dépendance local (resolved.deps) n'est pas synchronisé.
--cache=path Répertoire dans lequel stocker le cache de dépendances.

Par exemple, pour générer les fichiers resolved.deps pour tous les modules de votre projet, exécutez la commande suivante :

lightbuild resolve

Pour en savoir plus sur les fichiers resolved.deps, consultez Dépendances résolues.

lightbuild test

Exécute les tests de votre projet : les tests locaux, qui s'exécutent sur votre ordinateur de développement, et les tests d'instrumentation, qui s'exécutent sur un appareil connecté ou un émulateur en cours d'exécution. Pour tester un module, spécifiez sa cible, par exemple app-core. Pour n'exécuter qu'un seul type de test, ajoutez :hostTest pour les tests locaux ou :deviceTest pour les tests d'instrumentation à la cible.

lightbuild test [target] [--locked-dependencies]
Option ou argument Description
target Cible à tester. Par défaut, tous les tests de votre projet sont exécutés.
--locked-dependencies Échoue la compilation si le fichier de verrouillage de dépendance local (resolved.deps) n'est pas synchronisé.

Par exemple, pour exécuter tous les tests de votre projet, exécutez la commande suivante :

lightbuild test

Pour exécuter les tests locaux dans le module app-core, exécutez la commande suivante :

lightbuild test app-core:hostTest

Pour exécuter les tests d'instrumentation dans le module app-core sur un appareil ou un émulateur, exécutez la commande suivante :

lightbuild test app-core:deviceTest