Saltar al contenido

Esquema de blocks.json

Esquema completo

JSON
{
  "$schema": "https://blockstudio.dev/schema/blocks.json",
  "directory": "blockstudio",
  "registries": {
    "public": "https://example.com/registry.json",
    "private": {
      "url": "https://private.example.com/registry.json",
      "headers": {
        "Authorization": "Bearer ${REGISTRY_TOKEN}"
      }
    }
  }
}

Campos

Campo Tipo Obligatorio Descripción
$schema string No JSON Esquema URL para la validación del editor.
directory string Sí Ruta relativa desde blocks.json donde se instalan los bloques. No puede estar vacía.
registries Record<string, string | RegistryRef> Sí Mapa de nombres de espacios de nombres a referencias de registros. Puede estar vacío.

Formatos de referencia del registro

Cada valor de registries es una cadena URL o un objeto:

Cadena: URL válido a un archivo registry.json.

Objeto:

Campo Tipo Obligatorio Descripción
url string Sí URL válido a un archivo registry.json.
headers Record<string, string> No Encabezados HTTP que se envían con cada solicitud a este registro. Los valores admiten interpolación de ${ENV_VAR}.

Reglas de validación

  • directory debe ser una cadena no vacía.
  • Cada clave de registries debe ser una cadena no vacía.
  • Los valores de registro de tipo cadena deben ser URL válidas.
  • Los valores de registro de tipo objeto deben tener un campo url válido.
  • Las referencias ${ENV_VAR} en los encabezados se resuelven en tiempo de ejecución. Si falta una variable, se produce un error que indica su nombre y el encabezado.
  • El objeto registries puede estar vacío. En ese caso, add termina con No registries configured in blocks.json. Add a registry first., list imprime No registries configured. y search imprime No blocks matching "<query>".

Detección de configuración

El CLI busca blocks.json a partir del directorio de trabajo actual y recorre los directorios superiores hasta 20 niveles. Se usa el primer blocks.json que encuentra.