Aller au contenu

Traitement des ressources

Minification

Blockstudio peut minifier automatiquement tous les fichiers CSS et JS d’un bloc.

Les fichiers compilés sont enregistrés dans le dossier _dist du bloc et mis en file d’attente lorsqu’un bloc est utilisé. Lorsque le fichier source est mis à jour, Blockstudio vérifie si un fichier compilé portant cet horodatage existe ; sinon, il est créé.

La bibliothèque minify est utilisée à cette fin.

La minification peut être activée à l’aide du paramètre assets/minify :

PHP
add_filter('blockstudio/settings/assets/minify/css', function() {
  return true;
});

add_filter('blockstudio/settings/assets/minify/js', function() {
  return true;
});

SCSS

Si vous préférez écrire vos styles en SCSS, vous pouvez activer le traitement SCSS :

PHP
add_filter('blockstudio/settings/assets/process/scss', function() {
  return true;
});

Cela activera le traitement SCSS pour les fichiers .css.

Vous pouvez aussi utiliser l’extension .scss ; les styles seront alors automatiquement traités même si le paramètre ci-dessus n’est pas true.

Chemins d’importation

Avec SCSS, il est possible d’importer d’autres fichiers SCSS. Les imports sont relatifs au fichier depuis lequel ils sont effectués.

CSS
@import "modules.scss";

De plus, des chemins d’importation personnalisés peuvent être définis à l’aide du filtre blockstudio/assets/process/scss/import_paths, afin d’importer des fichiers depuis d’autres répertoires sans préciser de structure de dossiers.

Les imports peuvent omettre l’extension .scss et résoudre des fichiers partiels tels que _tokens.scss ou le fichier _index.scss d’un répertoire.

PHP
add_filter('blockstudio/assets/process/scss/import_paths', function($paths) {
  $paths[] = get_template_directory() . '/scss';
  return $paths;
});

Préambule

Si vous souhaitez disposer de fonctions, variables, mixins ou utilitaires Sass communs dans chaque fichier SCSS, vous pouvez ajouter un préambule global avant la compilation.

C’est utile pour des frameworks comme Bootstrap, où vous pouvez vouloir accéder à des mixins communs, comme les points de rupture, sans répéter les imports dans chaque ressource de bloc.

PHP
add_filter('blockstudio/assets/process/scss/prelude', function($prelude, $path, $scss) {
  return '@import "functions";' . "\n"
    . '@import "variables";' . "\n"
    . '@import "mixins";';
}, 10, 3);

Associé à blockstudio/assets/process/scss/import_paths, cela rend la surface Sass référencée disponible dans chaque fichier compilé.

Les ressources de bloc sont recompilées lorsque l’heure de modification d’une dépendance change, y compris celle des fichiers importés par d’autres fichiers partiels. Blockstudio suit les dépendances locales @import, @use et @forward, y compris celles du préambule et des chemins d’importation configurés. Les dépendances partagées ne sont suivies qu’une fois, et les cycles ne peuvent pas entraîner de boucles lors de leur détection. Ces fichiers sont également inclus dans la liste de surveillance du cache d’exécution.

Par exemple, la modification de mixins/_wysiwyg.scss recompile global-styles.scss si celui-ci importe scss/_wysiwyg.scss, qui importe à son tour ce mixin. Il n’est pas nécessaire de modifier le fichier d’entrée. Les modules intégrés Sass et les imports distants sont exclus du graphe des dépendances locales.

Modules ES

Tous les scripts (en ligne et par défaut) dans Blockstudio sont chargés avec type="module" appliqué par défaut. Vous pouvez donc utiliser la syntaxe d’importation dans les scripts de vos blocs sans configuration supplémentaire.

Remarque

Pour en savoir plus sur les modules ES, consultez la documentation Web de MDN.

Imaginons le code suivant dans un script.js :

JavaScript
import { h, render } from "https://esm.sh/preact@10.15.1";
import htm from "https://esm.sh/htm@3.1.1";
import confetti from "https://esm.sh/canvas-confetti@1.6.0";

const html = htm.bind(h);

function App(props) {
  confetti();
  return html`<h1>Hello ${props.name}!</h1>`;
}

render(
  html`<${App} name="Hello from Preact!" />`,
  document.querySelector("#element")
);

L’exemple ci-dessus créerait un composant avec Preact, en important tous les composants et fonctions nécessaires depuis un CDN compatible ESM, ici esm.sh. Cette approche ne présente aucun problème en soi, mais elle nécessite de récupérer les ressources requises depuis un site externe, au risque de voir les scripts cesser de fonctionner si CDN est indisponible.

Blockstudio permet de télécharger facilement des modules ES dans le bloc, ce qui évite d’avoir recours à des CDN ESM externes en production.

Configuration

Pour télécharger un module dans le répertoire de votre bloc, utilisez le préfixe npm: suivi du nom et de la version du paquet :

JavaScript
import { h, render } from "npm:preact@10.15.1";
import htm from "npm:htm@3.1.1";
import confetti from "npm:canvas-confetti@1.6.0";

Cette syntaxe s’aligne sur la convention du spécificateur Denonpm.

Remarque

L’ancien préfixe blockstudio/ (e.g, blockstudio/preact@10.15.1) reste pris en charge pour assurer la compatibilité ascendante, mais nous recommandons d’utiliser le préfixe npm: pour les nouveaux projets. Consultez le guide de migration pour en savoir plus.

Blockstudio détecte automatiquement les imports dans les fichiers .js modifiés et les télécharge dans le répertoire local du bloc. Les fichiers téléchargés sont placés dans un dossier modules du répertoire du bloc.

Le fichier de script sera réécrit lors de l’enregistrement pour utiliser le module hébergé localement :

JavaScript
import { h, render } from "./modules/preact/10.15.1.js";
import htm from "./modules/htm/10.15.1.js";
import confetti from "./modules/canvas-confetti/1.6.0.js";

Dans l’éditeur, l’URL CDN sera toujours utilisée (Blockstudio utilise esm.sh) lors de la prévisualisation et de la modification du bloc.

Limites

Version

En temps normal, les modules peuvent être utilisés depuis des CDN sans numéro de version. Dans ce cas, la version la plus récente est toujours utilisée. Comme Blockstudio n’enregistre aucune information dans la base de données, un numéro de version est nécessaire pour utiliser des modules.

Modules identiques

Les modules sont propres à leurs blocs. Même si vous utilisez le même module avec le même numéro de version dans plusieurs blocs, Blockstudio téléchargera quand même le module demandé dans chaque bloc. Cela s’explique principalement par le fait que les blocs doivent être autonomes pour pouvoir être facilement partagés entre différentes installations ou différents sites.

De plus, le même module sera demandé deux fois si les deux blocs sont présents sur une page. Pour résoudre ce problème, utilisez script-inline.js à la place du fichier script.js. Blockstudio réécrira chaque import pour qu’il pointe vers l’emplacement de la première occurrence du module, si son nom et son numéro de version sont identiques.

Chargeur CSS

Il est également possible d’importer des fichiers CSS en utilisant la même syntaxe que ci-dessus.

JavaScript
import "npm:swiper@11.0.0/swiper.min.css";

Le fichier CSS sera téléchargé dans le dossier modules et automatiquement mis en file d’attente lorsqu’un bloc est utilisé. Tant que la version est identique, une seule version du fichier CSS sera mise en file d’attente, même s’il existe dans plusieurs blocs.