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.