Configurer votre projet

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 1 minute de lecture
  • Créez le projet de composant et l’ensemble de fichiers nécessaires au développement d’un composant. Vous pouvez vous connecter à votre instance et créer un périmètre de l’application pour votre composant, ou réserver un périmètre à vérifier ultérieurement.

    Avant de commencer

    Configurer votre environnement.

    Procédure

    1. Créez un dossier pour votre projet et pointez l’outil de ligne de commande de votre système vers le dossier.
    2. Créez le projet de composant et tous les fichiers nécessaires à la création d’un composant.
      1. À partir du dossier que vous avez créé, exécutez cette commande.
        $ snc ui-component project [--name name --description description --scope scope --offline]

        Transmettez des valeurs pour ces arguments.

        Nom Description
        nom Requis. Le nom du projet. Doit être un nom de package npm valide et unique.
        description La description du projet qui sera disponible dans le registre npm et la liste des modules d’extension dans votre instance.
        périmètre Périmètre de l’application suggéré à affecter à ce projet et à ses composants. S’il est fourni, l’instance valide le nom. Utilisez les directives relatives à l’identificateur d’espace de noms pour le développement d’applications sur l’instance. Pour plus d’informations, consultez Périmètre de l’application.

        Maximum : 18 caractères.

        Cas : étui serpent.

        Valeur par défaut : x_customerprefix_componentname, où :
        • customerPrefix est la valeur de la glide.appcreator.company.code propriété système sur votre instance.
        • componentName est la valeur fournie dans le paramètre nom du composant lors de la création du projet.

        Vous pouvez également ajouter une valeur au paramètre scopeName dans le fichier now-ui.json . Pour plus d'informations, consultez Modifier le périmètre de l’application d’un composant.

        offline Si la valeur est vraie, crée et échafaude un composant lorsqu’elle est déconnectée de votre instance. Ignore la validation du nom de champ d’application donné.

        Valeur par défaut : faux.

        $ snc ui-component project --name @myorg/movie-quotes --description 'A web component that prints movie quotes.'
        $ snc ui-component project --name @myorg/hello-world --scope x_myorg_helloworld --offline
    3. Exécutez la commande suivante pour installer les dépendances npm.
      npm install

    Que faire ensuite

    Développer un composant.