Saltar al contenido

Alojar un registro

Un registro es un archivo registry.json y un conjunto de carpetas de bloques servidos mediante HTTP. No se necesita ningún servidor especial. Sirve cualquier servicio capaz de servir archivos estáticos.

Requisitos

  1. Un archivo registry.json que enumere sus bloques
  2. Carpetas de bloques con los archivos a los que hace referencia el manifiesto
  3. Un servidor web o servicio de alojamiento que sirva ambos elementos

Estructura de directorios

Un repositorio de registro típico tiene este aspecto:

Código
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

El registry.json señala el directorio blocks/ como su baseUrl:

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

Requisitos

El alojamiento debe admitir el acceso directo a archivos mediante URL. El CLI obtiene los archivos construyendo URL a partir de {baseUrl}/{block.name}/{file}.

El CLI no tiene un flujo de inicio de sesión propio. Para registros privados, gestione el control de acceso en la capa de alojamiento (e.g. repositorios privados GitHub con tokens o un servidor que compruebe las credenciales) y haga que los consumidores envíen las credenciales como encabezados personalizados mediante el formato de objeto en blocks.json.

Probar el registro

Antes de publicar, pruébelo localmente iniciando un servidor HTTP sencillo:

Shell
cd my-registry
npx serve .

Luego, apunte su blocks.json a http://localhost:3000/registry.json y ejecute npx blockstudio list para comprobar que todo se resuelve. list solo obtiene registry.json. Para probar add, establezca baseUrl en http://localhost:3000/blocks durante las pruebas, porque el CLI descarga los archivos de bloque desde baseUrl.