Saltar al contenido

Esquema de registry.json

Esquema completo

JSON
{
  "$schema": "https://blockstudio.dev/schema/registry.json",
  "name": "my-registry",
  "description": "A collection of WordPress blocks.",
  "baseUrl": "https://example.com/blocks",
  "blocks": [
    {
      "name": "hero",
      "title": "Hero",
      "description": "Full-width hero section with heading and CTA.",
      "category": "layout",
      "type": "blockstudio",
      "dependencies": ["button"],
      "files": [
        "block.json",
        "index.php",
        "style.scss"
      ]
    }
  ]
}

Campos de nivel superior

Campo Tipo Obligatorio Descripción
$schema string No JSON Esquema URL para la validación del editor.
name string Sí Identificador del registro. No puede estar vacío.
description string No Descripción breve del registro.
baseUrl string Sí URL base para descargar archivos de bloque. Debe ser un URL válido.
blocks BlockEntry[] Sí Matriz de bloques disponibles. Debe contener al menos una entrada.

Campos de entrada del bloque

Campo Tipo Obligatorio Descripción
name string Sí Nombre de la carpeta del bloque e identificador CLI. No puede estar vacío.
title string No Nombre visible para las personas.
description string No Descripción de una línea para los resultados de búsqueda.
category string No Etiqueta de agrupación para la salida de la lista.
type "blockstudio" | "create-block" | "wordpress" No Tipo de bloque. Solo informativo; no afecta al comportamiento de CLI.
dependencies string[] No Nombres de bloques del mismo registro que deben instalarse junto con este bloque.
files string[] Sí Rutas de archivos relativas a la carpeta del bloque. Se requiere al menos un archivo.

Resolución de archivos

Cada archivo se descarga desde:

Código
{baseUrl}/{block.name}/{file}

Y se escribe en:

Código
{directory}/{block.name}/{file}

Los subdirectorios de las rutas de archivos se crean automáticamente.

Reglas de validación

  • name no puede estar vacío ni en el nivel del registro ni en el del bloque.
  • baseUrl debe ser un URL válido.
  • blocks debe contener al menos una entrada.
  • files de cada bloque debe contener al menos una entrada.
  • Si se proporciona type, debe ser uno de los tres valores permitidos.
  • Si se proporciona dependencies, debe ser una matriz de cadenas. Cada dependencia debe existir en el mismo registro o el CLI generará un error al resolverla.