Branchez le pack dans votre chaîne d’outils : Vite ou webpack pour l’empaquetage, TypeScript pour les types, puis les tests de vos écrans et l’intégration continue. Chaque section donne un exemple à adapter à votre projet.
Provisoire
Les noms de paquets @unisson/<framework> et les composants d’enveloppe <O<Pascal>> (par exemple OButton) sont provisoires : ils suivront le nom définitif du produit. Les balises natives, elles, gardent leur nom bythium-<nom>.
Le pack est livré en modules ES : Vite le prend en charge sans réglage propre au pack.
En HTML, aucun plugiciel n’est requis. Avec Vue, React ou Svelte, gardez le plugiciel habituel de votre framework ; les enveloppes s’importent comme n’importe quel composant.
isCustomElement sert seulement si vos gabarits contiennent aussi des balises natives bythium-<nom>.import { defineConfig } from 'vite';
// Aucun plugiciel requis pour les balises natives
export default defineConfig({});Avec webpack, le pack se résout comme tout paquet en modules ES. La configuration ci-dessous montre le minimum pour un projet TypeScript ; ajoutez le chargeur de votre framework s’il y a lieu.
Le point d’entrée importe le paquet de votre format, comme à la page Démarrer.
const path = require('node:path');
module.exports = {
mode: 'production',
entry: './src/main.ts',
output: {
path: path.resolve(__dirname, 'dist'),
filename: '[name].[contenthash].js',
clean: true,
},
resolve: {
extensions: ['.ts', '.tsx', '.js'],
},
module: {
rules: [
{ test: /\.tsx?$/, use: 'ts-loader', exclude: /node_modules/ },
],
},
};// Définit toutes les balises bythium-<nom>
import '@unisson/web-components';Note
Gardez les imports nommés (import { OButton } from …) : webpack peut alors écarter du lot les composants inutilisés.
Les types viennent avec chaque paquet : rien d’autre à installer.
Activez le mode strict et la résolution de modules de votre empaqueteur. Les attributs et leurs valeurs permises sont alors vérifiés à la compilation.
En Vue et en Svelte, déclarez lang="ts" sur le bloc de script du fichier et importez-y OButton depuis le paquet de votre format.
Une valeur hors contrat, comme un variant inconnu, est signalée par le compilateur avant l’exécution.
{
"compilerOptions": {
"strict": true,
"module": "ESNext",
"moduleResolution": "bundler",
"skipLibCheck": true,
"noEmit": true
},
"include": ["src"]
}import '@unisson/web-components';
const bouton = document.querySelector('bythium-button');
bouton?.setAttribute('variant', 'primary');Testez vos écrans comme une personne les utilise : cherchez un composant par son texte ou son rôle, puis vérifiez ce qu’il affiche. L’exemple utilise Vitest ; le même principe vaut pour un autre lanceur de tests.
import { expect, test } from 'vitest';
import '@unisson/web-components';
test('le bouton principal est affiché', async () => {
await customElements.whenDefined('bythium-button');
document.body.innerHTML =
'<bythium-button variant="primary">Enregistrer</bythium-button>';
const bouton = document.querySelector('bythium-button');
expect(bouton.getAttribute('variant')).toBe('primary');
expect(bouton.textContent).toContain('Enregistrer');
});import { defineConfig } from 'vitest/config';
export default defineConfig({
test: {
// Les composants ont besoin d’un DOM
environment: 'jsdom',
},
});Note
L’environnement de test doit fournir un DOM et les éléments personnalisés (customElements). Si le vôtre ne les offre pas, lancez ces tests dans un vrai navigateur.
Les mêmes commandes sur votre poste et sur le serveur d’intégration.
Déclarez les vérifications comme scripts npm, puis faites-les exécuter dans l’ordre par votre service d’intégration continue, quel qu’il soit.
{
"scripts": {
"typecheck": "tsc --noEmit",
"test": "vitest run",
"build": "vite build"
}
}Installez à partir du fichier de verrouillage, pour obtenir les mêmes versions qu’en local.
$ npm ciLe compilateur confirme que les attributs des composants respectent leur contrat.
$ npm run typecheckLes tests de vos écrans s’exécutent une fois, sans mode de surveillance.
$ npm testLa construction de production échoue si un import du pack est introuvable.
$ npm run buildNote
Versionnez le fichier package-lock.json : sans lui, npm ci refuse de s’exécuter.
Page de maquette, contenu cible.Proposer une modification