Aller au contenu principal
Version: Next

Vite (blocks, assets)

Contexte

Cette migration est nécessaire depuis la version 26.0.10.0 d'Elementum. Elle permet de continuer à créer des blocks Gutenberg qui soient correctement reconnus par le framework.

Contexte et problématique​

Avant la migration​

Initialement, un seul fichier de configuration Vite (vite.config.js) gérait la compilation de tous les assets :

  • TypeScript admin, front, customize
  • Blocks Gutenberg
  • SCSS

Le problème rencontré​

L'activation du plugin React de Vite pour créer des composants React injectait un runtime JSX dans le code compilé des blocks Gutenberg. Ce runtime entrait en conflit avec le runtime React de Gutenberg, provoquant des erreurs.

Conséquences :

  • ❌ Avec le plugin React : les blocks Gutenberg personnalisés étaient en erreur
  • ❌ Sans le plugin React : impossible d'utiliser des composants React dans l'admin, le front et le customize

La solution​

Séparer les configurations Vite en deux fichiers distincts :

  • vite.frontend.config.js : pour l'admin, le front et le customize
  • vite.blocks.config.js : spécifiquement pour les blocks Gutenberg

Le dossier de sortie des blocks a été déplacé vers blocks/dist.


Migration étape par étape​

1. Copier les configurations Vite​

Récupérez les deux fichiers de configuration depuis le boilerplate Elementum :

Source : elementum/boilerplate/ (dans le dossier du thème ou du plugin, selon le projet cible)
Destination : racine de votre projet

Fichier à copier
vite.frontend.config.js
vite.blocks.config.js

Une fois copiés, supprimez l'ancien fichier vite.config.js.

2. Mettre à jour le package.json​

a) Modifier les scripts​

Remplacez la section "scripts" de votre package.json :

package.json
{
    "scripts": {
        "dev:front": "vite build --watch --config vite.frontend.config.js",
        "dev:block": "vite build --watch --config vite.blocks.config.js",
        "dev": "concurrently -n FRONT,BLOCK \"npm run dev:front\" \"npm run dev:block\"",
        "build": "vite build --config vite.frontend.config.js && vite build --config vite.blocks.config.js"
    }
}

b) Modifier le point d'entrée​

Mettez à jour le champ "main" pour pointer vers la nouvelle configuration :

package.json
{
    "main": "vite.frontend.config.js"
}

3. Installer la dépendance​

Le script dev utilise concurrently pour exécuter les deux builds en parallèle :

npm install concurrently --save-dev

4. Vérifier la migration​

Exécutez un build complet pour générer les assets et valider que tout fonctionne :

npm run build
Vérification

Assurez-vous que :

  • Les assets front-end sont générés correctement
  • Les blocks Gutenberg sont bien compilés dans blocks/dist
  • Aucun conflit React n'apparaît dans la console