[#MUI-2] Faire un MCP pour la librairie de composant (#20)
| Numéro du ticket | Titre du ticket | |------------------|-----------------| | | | ## Description de la PR ## Modification du .env ## Check list - [ ] Pas de régression - [ ] TU/TI/TF rédigée - [ ] TU/TI/TF OK - [ ] CHANGELOG modifié Reviewed-on: #20 Co-authored-by: tristan <tristan@yuno.malio.fr> Co-committed-by: tristan <tristan@yuno.malio.fr>
This commit was merged in pull request #20.
This commit is contained in:
@@ -7,7 +7,7 @@ description: Use when creating a new UI component in the @malio/layer-ui Nuxt la
|
||||
|
||||
## Overview
|
||||
|
||||
Step-by-step process for creating a component in `@malio/layer-ui`. Each component requires 5 deliverables : le `.vue`, les tests, la page playground, la story Histoire, et la mise à jour du CHANGELOG.
|
||||
Step-by-step process for creating a component in `@malio/layer-ui`. Each component requires 6 deliverables : le `.vue`, les tests, la page playground, la story Histoire, la mise à jour du CHANGELOG, et la mise à jour du `COMPONENTS.md`.
|
||||
|
||||
## When to Use
|
||||
|
||||
@@ -27,6 +27,7 @@ digraph create_component {
|
||||
"Tests OK?" -> "3. Créer les tests .test.ts" [label="non, corriger"];
|
||||
"5. Créer la page playground" -> "6. Créer la story Histoire";
|
||||
"6. Créer la story Histoire" -> "7. Mettre à jour CHANGELOG.md";
|
||||
"7. Mettre à jour CHANGELOG.md" -> "8. Mettre à jour COMPONENTS.md";
|
||||
}
|
||||
```
|
||||
|
||||
@@ -176,6 +177,37 @@ Pour extraire le numéro de ticket depuis la branche courante :
|
||||
git branch --show-current | grep -oP '(MUI-\d+|\d{3,})' | head -1
|
||||
```
|
||||
|
||||
### 8. Mettre à jour COMPONENTS.md
|
||||
|
||||
**Fichier :** `COMPONENTS.md` à la racine du projet.
|
||||
|
||||
Ce fichier sert de documentation de référence pour les projets qui consomment `@malio/layer-ui`. Il est lu par Claude dans les projets consommateurs pour connaître les composants disponibles et leurs props.
|
||||
|
||||
**Ajouter une section pour le nouveau composant** en suivant le format existant :
|
||||
|
||||
```markdown
|
||||
## MalioNomComposant
|
||||
|
||||
Description courte du composant.
|
||||
|
||||
| Prop | Type | Défaut | Description |
|
||||
|------|------|--------|-------------|
|
||||
| ... | ... | ... | ... |
|
||||
|
||||
**Events :** `update:modelValue(value: string)`
|
||||
|
||||
\`\`\`vue
|
||||
<MalioNomComposant v-model="val" label="Exemple" />
|
||||
\`\`\`
|
||||
```
|
||||
|
||||
**Checklist :**
|
||||
- Toutes les props documentées avec type, défaut et description
|
||||
- Events listés
|
||||
- Slots listés si applicable
|
||||
- 2-5 exemples d'utilisation couvrant les cas courants (simple, avec options, disabled, erreur)
|
||||
- Section placée par ordre logique (inputs ensemble, boutons ensemble, etc.)
|
||||
|
||||
## Common Mistakes
|
||||
|
||||
Cette section est alimentée au fur et à mesure des retours utilisateur et des problèmes rencontrés. **Si un retour ou un bug est identifié lors de la création d'un composant, ajouter une ligne dans ce tableau.**
|
||||
@@ -188,3 +220,4 @@ Cette section est alimentée au fur et à mesure des retours utilisateur et des
|
||||
| Padding input pas ajusté avec icône | Ajouter `!pr-10` (ou équivalent) quand une icône est présente à droite |
|
||||
| Story sans initial state | Toujours initialiser les `ref` avec des valeurs pour que les variantes soient visibles dès le chargement |
|
||||
| CHANGELOG oublié | Toujours ajouter la ligne dans `### Added` avant de commit |
|
||||
| COMPONENTS.md pas mis à jour | Ajouter la doc du composant dans `COMPONENTS.md` — c'est la référence pour les projets consommateurs |
|
||||
|
||||
Reference in New Issue
Block a user