Aller au contenu

Héberger un registre

Un registre est un fichier registry.json et un ensemble de dossiers de blocs servis via HTTP. Aucun serveur particulier n’est nécessaire. Tout système capable de servir des fichiers statiques convient.

Prérequis

  1. Un fichier registry.json répertoriant vos blocs
  2. Des dossiers de blocs contenant les fichiers référencés dans le manifeste
  3. Un serveur web ou un service d’hébergement qui sert les deux

Structure des répertoires

Voici à quoi ressemble généralement un dépôt de registre :

Code
my-registry/
  registry.json
  blocks/
    hero/
      block.json
      index.php
      style.scss
    tabs/
      block.json
      index.php
      style.scss
    tab-item/
      block.json
      index.php

Le registry.json indique le répertoire blocks/ comme son baseUrl :

JSON
{
  "name": "my-registry",
  "baseUrl": "https://example.com/blocks",
  "blocks": [
    {
      "name": "hero",
      "title": "Hero",
      "files": ["block.json", "index.php", "style.scss"]
    }
  ]
}

Prérequis

L’hébergement doit permettre l’accès direct aux fichiers via URL. Le CLI récupère les fichiers en construisant des URL à partir de {baseUrl}/{block.name}/{file}.

Le CLI ne gère pas lui-même la connexion. Pour les registres privés, gérez le contrôle d’accès au niveau de l’hébergement (e.g. dépôts privés GitHub avec des jetons, ou serveur vérifiant les identifiants) et demandez aux utilisateurs d’envoyer leurs identifiants comme en-têtes personnalisés via le format objet dans blocks.json.

Tester votre registre

Avant la publication, testez votre registre en local en lançant un serveur HTTP simple :

Shell
cd my-registry
npx serve .

Indiquez ensuite blocks.json à http://localhost:3000/registry.json et lancez npx blockstudio list pour vérifier que tout est résolu. list récupère uniquement registry.json. Pour tester add, définissez baseUrl sur http://localhost:3000/blocks pendant le test, car le CLI télécharge les fichiers de bloc depuis baseUrl.