Installer une vue
Installer une vue
La commande views install permet d’installer une vue existante dans le projet.
Elle télécharge l’archive de la vue, vérifie sa compatibilité avec le projet, puis copie les fichiers nécessaires selon les options utilisées.
Utilisation
La commande peut également être utilisée avec des options complémentaires :
Paramètres
Paramètre | Description | Obligatoire |
|---|---|---|
<viewId> | Identifiant de la vue à installer. | Oui |
<viewVersion> | Version de la vue à installer. | Oui |
Options disponibles
Option | Description |
|---|---|
--copy-oip-config | Copie la configuration OIP associée à la vue. |
--only-zip | Récupère uniquement l’archive de la vue. |
--only-view | Installe uniquement les fichiers de la vue. |
--override-view | Autorise l’écrasement d’une vue déjà présente dans le projet. |
--update-package-json | Met à jour le fichier package.json avec les dépendances externes déclarées dans le manifest. |
--view-name <nom> | Définit un nom de vue spécifique lors de l’installation. |
Fonctionnement général
La commande réalise plusieurs étapes :
- téléchargement de l’archive de la vue ;
- vérification de la compatibilité avec la version de @fasstech/oip-core utilisée par le projet ;
- copie des fichiers de configuration et des fichiers de vue selon les options utilisées ;
- mise à jour optionnelle du fichier package.json avec les dépendances externes déclarées dans le manifest.yml.
Vérification de compatibilité
Lors de l’installation, OIP Tools vérifie la compatibilité entre :
- la version de @fasstech/oip-core requise par la vue ;
- la version de @fasstech/oip-core installée dans le projet.
Si les versions ne sont pas compatibles, l’installation est bloquée.
Cas bloquants
L’installation peut être bloquée dans plusieurs cas.
Cas | Description |
|---|---|
Vue déjà existante | Si la vue existe déjà dans le projet et que l’option --override-view n’est pas utilisée. |
Version OIP Core incompatible | Si la version d’OIP Core requise par la vue est différente de celle utilisée par le projet. |
Exemples
Installer une vue :
Installer une vue en autorisant l’écrasement d’une vue existante :
Installer une vue et mettre à jour le fichier package.json :
Installer une vue avec un nom spécifique :
Remarques
La commande nécessite un accès réseau à l’OIP API.
Les variables d’environnement nécessaires à l’authentification doivent être correctement renseignées, notamment OIP_TOOLS_CLIENT_SECRET.
Avant d’installer une vue, il est recommandé de vérifier :
- la version de la vue à installer ;
- la version d’OIP Core utilisée par le projet ;
- la présence éventuelle d’une vue du même nom dans le projet ;
- les dépendances déclarées dans le manifest de la vue.