Présentation
Views Generator
OIP Views Generator permet de générer un bundle de vue React prêt à l’emploi à partir de fichiers de configuration au format YAML.
Il permet également de gérer les vues d’un projet OIP à travers plusieurs commandes dédiées : lister les vues disponibles, rechercher une vue, uploader une vue, installer une vue existante, générer les vues du projet ou encore produire un graphe Mermaid représentant les vues.
Chaque vue générée est indépendante des autres. Elle embarque sa propre partie cliente, sa partie serveur, ses accesseurs et les éléments nécessaires à son fonctionnement.
Fonctionnement général
À partir des fichiers YAML présents dans le dossier de configuration des vues, OIP Views Generator produit l’ensemble des fichiers nécessaires à l’exécution des vues dans un projet OIP.
Par défaut, les fichiers de configuration des vues sont attendus dans le dossier suivant :
Un fichier YAML est attendu pour chaque vue.
Exemple :
Par convention, le nom du fichier correspond à l’identifiant unique de la vue. Il peut être préfixé par deux chiffres afin d’indiquer l’ordre d’apparition de la vue dans le parcours.
Par exemple, pour une vue customer qui serait la deuxième vue du parcours, le fichier de configuration peut être nommé :
Fichiers de transition
La génération des vues s’appuie également sur des fichiers de transition.
Ces fichiers définissent les vues accessibles depuis chaque étape du parcours, notamment lors d’une action de navigation vers la vue suivante ou vers la vue précédente.
Les fichiers de transition associés aux vues sont attendus dans le dossier suivant :
Par convention, le nom d’un fichier de transition doit correspondre à la valeur viewId de la vue associée.
Exemple :
Lors de l’exécution de la commande views generate, si le fichier de transition associé à une vue est absent ou comporte des erreurs, une erreur est retournée.
Contenu généré
Le bundle généré peut notamment contenir :
- les composants React associés aux vues ;
- les hooks nécessaires côté client ;
- les requêtes et mutations GraphQL générées ;
- les éléments serveur nécessaires au traitement des vues ;
- les resolvers GraphQL ;
- les types GraphQL associés ;
- les fichiers de transition ;
- les fichiers d’index permettant d’exposer les vues dans l’application.
Modification des fichiers générés
De nombreux fichiers générés par OIP Views Generator ne doivent pas être modifiés directement.
Ces fichiers sont identifiés grâce au commentaire d’en-tête suivant :
Tout fichier contenant cet en-tête doit être considéré comme généré automatiquement. Il peut être écrasé lors d’une prochaine génération.
Il est important de respecter cette indication :
- les fichiers autorisés à la modification peuvent être adaptés selon les besoins du projet ;
- les fichiers indiqués comme non modifiables ne doivent pas être modifiés manuellement.
La modification d’un fichier marqué comme non modifiable peut entraîner des dysfonctionnements dans l’application ou être écrasée lors d’une nouvelle génération.
Commandes disponibles
OIP Tools - Views Generator regroupe plusieurs commandes permettant de gérer les vues d’un projet OIP.
Commande | Description |
|---|---|
generate | Génère les vues de l’application à partir des fichiers de configuration YAML. |
graph | Génère un graphe Mermaid représentant les vues. |
generate
La commande generate permet de générer les vues de l’application à partir des fichiers de configuration YAML présents dans config/views.
Elle vérifie également les fichiers de transition présents dans le dossier transitions.
graph
La commande graph permet de générer un graphe Mermaid représentant les vues.
Point d’attention
La génération des vues doit être relancée après toute modification significative des fichiers YAML de configuration.
Il est également recommandé de vérifier que chaque vue dispose bien du fichier de transition attendu dans le dossier transitions.
Les fichiers générés contenant l’en-tête Code generated by gen. DO NOT EDIT. ne doivent pas être modifiés manuellement.