@sia-ui/cli
v0.8.0
Published
Install SIA UI components progressively into an application.
Maintainers
Readme
@sia-ui/cli
Installer les composants SIA UI dans une application, comme shadcn/ui.
pnpm dlx @sia-ui/cli init
pnpm dlx @sia-ui/cli add data-table crud-pageinit écrit sia-ui.json et la feuille de style
list liste les composants, [pkg] = servi par le package
add <nom...> installe, avec ses dépendances de registre
add <nom> --overwrite écrase une copie existanteLes chemins d'installation viennent de sia-ui.json :
{
"components": "src/components",
"lib": "src/lib",
"styles": "src/styles/sia-ui.css"
}La CLI copie le fichier source tel quel et annonce les paquets npm à installer plutôt que de les installer d'office :
add src/components/DataTable/index.tsx
add src/components/DataTable/styles.css
À installer :
pnpm add @sia-ui/headless @sia-ui/react @sia-ui/tokens @sia-ui/utilsPlace dans SIA UI
@sia-ui/tokens valeurs : couleurs, espacements, mouvement, vocabulaire
@sia-ui/utils fonctions sans dépendance
@sia-ui/api client HTTP — indépendant de l'interface
@sia-ui/headless comportement, avec React, sans plateforme
@sia-ui/react primitives de runtime DOM
@sia-ui/react-web composants DOM
@sia-ui/react-native composants natifs, à venirUne chose s'écrit au niveau le plus bas où elle a du sens, et une seule fois. Voir la documentation.
Contribuer
Le code source principal de SIA UI est privé pour le moment. Les retours publics passent par le dépôt BeatJo/sia-ui-site : bugs, demandes de composants, corrections de documentation et questions d'usage.
- Signaler un bug : https://github.com/BeatJo/sia-ui-site/issues
- Lire la documentation : https://beatjo.github.io/sia-ui-site/
- Voir la démonstration : https://beatjo.github.io/sia-ui-site/preview/
Les contributions directes au code des packages se font sur invitation dans le dépôt source privé.
Journal des changements
Le contenu ci-dessous reprend intégralement CHANGELOG.md pour rester visible sur npm.
@sia-ui/cli
0.8.0
Minor Changes
- Version alignée sur les autres paquets SIA UI : tous sortent désormais ensemble, au même numéro.
0.7.1
Patch Changes
- Aligne les packages publics de SIA UI sur la version 0.7.1 afin que les huit packages restent sur une version commune.
0.7.0
Minor Changes
- Aligne les packages publics de SIA UI sur la version 0.7.0 afin que les huit packages restent sur une version commune.
0.6.0
Minor Changes
sia-ui update, la feuille commune suivie, et des erreurs HTTP en français.sia-ui update [nom...]— met à jour les entrées en retard sans perdre de retouche : un fichier intact est remplacé, un fichier modifié depuis son installation est gardé et signalé (sia-ui diff, puis--forcepour l'écraser). Les dépendances de registre apparues sont installées, les paquets npm annoncés.--dry-runmontre sans rien écrire. Une entrée dont un fichier a été gardé reste « en retard » dans le verrou.sia-ui.csssuivie — son empreinte est notée danssia-ui.lock.json.updatela met à jour comme un composant ;addaussi, si elle n'a pas été retouchée.initne fait plus qu'initialiser. Elle est lue au même registre que les composants, HTTP compris.doctorsignale une feuille en retard, modifiée ou copiée avant le suivi.list --outdatedetdoctorconseillentsia-ui updateau lieu deadd --overwrite, qui écrasait aussi les retouches.statusMessages(@sia-ui/api) — option du client, avecFRENCH_STATUS_MESSAGES. Remplace les messages génériques du serveur (« Conflict », « Forbidden resource », « Cannot GET /x »,ThrottlerException) et l'échec réseau defetch, jamais un message métier ni une erreur de champs.
0.5.0
Patch Changes
Erreurs serveur dans les formulaires, client HTTP plus sûr, registre vérifié.
Défauts
- Registre
drawer—context.tset la dépendanceiconsmanquaient :sia-ui add app-shellproduisait un projet qui ne compilait pas. Un test vérifie désormais que chaque import relatif de chaque entrée est apporté par son installation. sia-ui.cssposebox-sizing: border-box(spécificité nulle). Sans reset côté projet,AppShelldébordait de 32 px.@sia-ui/apine rejoue plus d'office queGETetHEAD(retryMethods). Une écriture n'est rejouée que si l'appel poseretry.- Plus aucun avertissement
react-hooks/exhaustive-depsdans les composants.
Formulaires et erreurs serveur
Formintercepte un envoi rejeté : erreurs de champ sous les champs, le reste dans une alerte.onSubmitpeut aussi rendre{ champ: message }(FormSubmitResult), dansuseLocalForm,Form,CrudPageet l'adaptateur react-hook-form.CrudPagegarde alors sa boîte ouverte.- Les erreurs posées par
setErrorssurvivent à la validation locale jusqu'à la modification de leur champ. HttpError.toFormErrors(), optionfieldErrorsdu client et préréglagenestFieldErrors(class-validator).readSubmitErrorethasFormErrorsdans@sia-ui/headless.- La pagination à plat
{ data, total, page, limit }est reconnue, etgetne déballe plusdataquand l'objet porte une pagination.
Tableaux
searchDelaysurDataTableetCrudPage.CrudPageplace lesextraRowActionsavant « Supprimer ».
- Registre
0.4.0
Minor Changes
- Aligne tous les packages publics SIA UI sur la version 0.4.0 afin de fournir un ensemble cohérent à installer, documenter et maintenir.
0.3.2
Patch Changes
- Ajoute l’identité visuelle officielle de SIA UI et améliore la documentation publique, les changelogs et les ressources de contribution.
0.3.1
Patch Changes
- Expose public contribution flow on npm
0.3.0
Minor Changes
Une ressource se déclare une fois, cinq composants refondus, et une documentation qui décrit le produit plutôt que son développement.
Déclarer une ressource
defineResourcedécrit un objet métier une seule fois. Les colonnes du tableau, les champs du formulaire, les lignes de la vue de détail, la validation, les clés de recherche et les quatre règles de droits en sont dérivés — et chaque dérivation reste remplaçable par la prop correspondante.<CrudPage resource={FACTURE} data={factures} can={can} onSubmit={…} onDelete={…} />Le rendu se déduit du type : un
currencys'affiche formaté et aligné à droite, unselectavec sestonesdevient une pastille, unedatepasse par le format local.permissions: "auto"applique la convention<nom>.<verbe>.Les quatre opérations ouvrent leurs propres boîtes
CrudPagen'appelle plus seulement un gestionnaire : déclarerfieldsetonSubmitsuffit à obtenir un formulaire vide en création, le même prérempli en modification, et une vue de détail.onCreate,onEditetonViewrestent la porte de sortie vers une page dédiée — fournis, ils passent devant la boîte.Les boîtes n'inventent rien :
Modalpour la boîte,Formpour la saisie,Descriptionspour la lecture.Cinq composants refondus
Sidebar— le rail réduit n'enferme plus ses sous-menus : ils sortent en volet. Profondeur illimitée, droits en cascade, trois variantes.AppShell— se branche sur n'importe quel routeur par une seule chaîne, l'adresse courante. Trois états de barre, tiroir ou onglets bas sur mobile, filtrage des droits fait une seule fois.Avatar— teinte dérivée du nom, repli peint sous l'image, quatre états de présence, et des piles qui résument leur surplus.DataTable— actions de ligne avec droits et confirmation, sélection et barre groupée, vue en cartes, trois densités, états de chargement, d'erreur et de vide.CrudPage— réécrit : il tenait en neuf lignes et n'offrait aucune des quatre opérations qui lui donnent son nom.
Ruptures
CrudPage:actionsportait des nœuds d'en-tête, ils vont dansheaderActions.dataest requis, etcolumnsl'est aussi à moins qu'uneresourcene les fournisse.SidebaretAppShell: les props ont changé. Voir La navigation latérale et La coquille d'application.
Documentation
Les cent trois composants ont désormais une page de référence — ce qu'ils font, comment les installer, et toutes leurs props avec type et valeur par défaut. Ces pages sont écrites par le code : les props viennent des types, les descriptions de leurs commentaires, la commande d'installation du registre.
Le catalogue est passé de seize sections en deux langues à neuf, ordonnées du plus général au plus assemblé. Les comptes rendus de développement ont été retirés de la documentation : ils décrivaient un chemin parcouru, pas un produit.
0.2.2
Patch Changes
- Restore the sia-ui executable
0.2.1
Patch Changes
- Include component styles in the CLI registry
0.2.0
Minor Changes
e4e4a72: Annonces, session et droits, formulaires sans dépendance, et vingt entrées de registre de plus.
Composants
- Annonces —
toast()s'appelle hors de React, varianteloading, boutons d'action, six coins réglables par annonce, balayage pour écarter, suivi de promesse. - Session et droits —
createSessionStoreavec sa machine à quatre états,createAccessLayerà évaluateur injecté,RequireSessionsans routeur. - Formulaires — le contrat
FormAdapteretuseLocalForm, sans dépendance.Formest écrit sur le contrat : il n'importe ni react-hook-form ni zod, et se câble à l'un ou l'autre par un adaptateur. - Vingt entrées de registre de plus —
progress,dropdown-menu,accordion,sidebar,breadcrumb,steps,toggle,scroll-area,hover-card,aspect-ratio,input-number,password-input,phone-input,chart,require-session,form… - Thème — mode
system, persistance et script anti-clignotement dansSiaProvider, en remplacement denext-themes.
@sia-ui/apiLe client HTTP typé est un paquet à part : ni React, ni DOM, ni tokens. Il s'installe seul, et copier un
Badgedepuis le registre ne l'entraîne pas.Utilitaires
@sia-ui/utilspasse de six à quatorze modules :query,async,collection,object,validation,file,clipboard,locale.Archives
- Plus de sourcemaps : elles pesaient environ soixante pour cent de chaque
archive —
@sia-ui/react-webpasse de 2,1 Mo à 759 Ko. - Chaque paquet porte enfin la licence MIT qu'il annonce.
Vitrine en ligne
Trois surfaces publiées sur GitHub Pages à chaque poussée sur
main: la documentation à la racine, le catalogue Storybook sous/storybook/, la démonstration sous/preview/. Le site de documentation est construit depuis les fichiers dedocs/eux-mêmes, qui restent du Markdown ordinaire.Le registre n'est plus une voie sans retour
Installer était jusqu'ici définitif : plus rien ne disait ce qu'on avait, ce qu'on avait retouché, ni ce qui avait bougé en amont — donc rien ne permettait de corriger ni de déprécier une entrée après coup.
sia-ui.lock.json, écrit à chaqueadd: version, date et empreinte de chaque fichier copié.- Quatre commandes :
diff,remove,doctor,list --outdated.removerefuse de casser un voisin ou d'effacer un fichier retouché. - Cycle de vie des entrées —
experimental,stable,deprecated,removed— avecreplacedBy.addrefuse ce qui est retiré,doctorsignale ce qui est déprécié chez qui l'a déjà installé. - Journal du registre, entrée par entrée, dont
pnpm check:changelogrefuse qu'il mente. - Registre servi en HTTP, versionné par l'URL :
…/r/v1/. Corriger une entrée n'oblige plus à republier la CLI.
Corrections
- La case à cocher et le bouton radio masquaient leur contrôle natif en
opacity:0. Le navigateur le peignait encore sous le visuel personnalisé, et ce dessin clignotait au clic. Les deux utilisent désormais la recette partagée.sia-visually-hidden, qui le découpe hors du rendu sans le retirer du clavier. - Une case à cocher non contrôlée ne se peignait jamais cochée : l'
<input>basculait, mais la classe qui dessine la case ne suivait pas. - Le curseur de survol des graphes était ovale, et le tracé de la courbe haché : les marqueurs sont sortis du SVG, qui est étiré sans conserver ses proportions.
- L'entrée
drawerdu registre était impossible à installer — elle importait deux dossiers que la CLI ne copie pas.
- Annonces —
Patch Changes
- Include component styles when installing registry components
Licence
MIT
