@q300z/codeforge
v1.7.0
Published
Industrial JSON to HTML Render Engine with Design Tokens and Multi-page support
Maintainers
Readme
🚀 CodeForge - Traducteur JSON → HTML
🎯 Objectif
CodeForge est une bibliothèque robuste dont la mission est de traduire une structure de données JSON en code HTML sémantique et accessible. Elle agit comme une couche de projection pure qui transforme un arbre déclaratif (le "Quoi") en un document web structuré (le "Comment"), en utilisant la puissance native du navigateur (Cascade CSS et Variables CSS).
✨ Fonctionnalités Clés
- 🔌 Adaptateur Intelligent : Détecte et transforme automatiquement les formats tiers (ex: ScreenDraft) en structure native CodeForge.
- 🎨 Système de Style Hybride : Supporte les Design Tokens (via CSS Variables) et les propriétés de mise en page natives (
width,height,z-index, etc.). - 📍 Positionnement Absolu : Support natif des coordonnées
xetypour un rendu de type "Canvas". - ♿ Accessibilité (A11y) Native : Injection automatique des rôles ARIA, descriptions audio et gestion des balises sémantiques.
- 📦 Sortie Autonome : Option pour injecter le CSS directement dans le HTML (
--inline) pour des fichiers 100% portables.
🛠 Utilisation
Installation
npm install @q300z/codeforgeEn tant que bibliothèque (Lib)
1. Génération de site (SSG)
import { buildSite } from "@q300z/codeforge";
// Génère un site complet avec CSS inline
await buildSite("./structure.json", "./dist", { inlineCss: true });2. Utilisation des Builders (Design Pattern)
import { SiteBuilder, PageBuilder, HeroBuilder, ButtonBuilder } from "@q300z/codeforge";
const site = new SiteBuilder("Mon App")
.addPage("index", new PageBuilder("home")
.addChild(new HeroBuilder("h1").withTitle("Hello World"))
.addChild(new ButtonBuilder("b1").withLabel("Cliquez-ici").withXY(50, 100))
)
.build();En tant qu'outil (CLI)
# Utilisation standard
npx codeforge ./data/site.json ./generated
# Avec auto-détection ScreenDraft et CSS inline
npx codeforge ./data/screendraft.json ./dist --inline
# Mode surveillance (Watch)
npx codeforge ./data/site.json ./generated --watch⌨️ Commandes
| Commande | Description |
| :--- | :--- |
| npm run dev | Lance le build lib + génération + serveur Vite. |
| npm run build | Compile la lib et génère le showcase complet. |
| npm run lint | Vérifie le code TypeScript (ESLint) et CSS (Stylelint). |
| npm run test:a11y | Lance l'audit d'accessibilité automatisé avec pa11y-ci. |
| npm run test:screendraft | Teste le pipeline complet d'import ScreenDraft → Rendu. |
🧪 Qualité & Tests
Le projet suit des standards de qualité industriels :
- Tests Unitaires : Couverture globale > 80% (Composants > 95%).
- Tests E2E : Validation des scénarios de navigation et du rendu visuel avec Playwright.
- Accessibilité : Validation WCAG 2.0 AA sur toutes les pages générées.
- Style CSS : Validation et formatage automatique via Stylelint.
npm test # Tests unitaires
npm run test:e2e # Tests Playwright
npm run test:a11y # Audit Accessibilité🏗 Architecture (SOLID)
CodeForge est construit sur des principes modulaires :
- Registry : Dictionnaire centralisé des composants.
- Factory : Création typée et sécurisée de nouveaux composants.
- Builders : Interface fluide pour construire des structures JSON sans erreurs.
- Adapters : Couche de compatibilité pour les sources de données externes.
Note : Le fichier
data/site.jsonsert de référence pour les tests. Toute modification majeure doit être répercutée dans les tests E2E.
