Vai al contenuto

Schema registry.json

Schema 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"
      ]
    }
  ]
}

Campi di primo livello

Campo Tipo Obbligatorio Descrizione
$schema string No Schema JSON URL per la convalida nell’editor.
name string Sì Identificatore del registro. Non può essere vuoto.
description string No Breve descrizione del registro.
baseUrl string Sì URL di base per scaricare i file dei blocchi. Deve essere un URL valido.
blocks BlockEntry[] Sì Array dei blocchi disponibili. Deve contenere almeno una voce.

Campi delle voci dei blocchi

Campo Tipo Obbligatorio Descrizione
name string Sì Nome della cartella del blocco e identificatore CLI. Non può essere vuoto.
title string No Nome visualizzato leggibile.
description string No Descrizione di una riga per i risultati di ricerca.
category string No Etichetta di raggruppamento per l’output dell’elenco.
type "blockstudio" | "create-block" | "wordpress" No Tipo di blocco. Solo informativo, non influisce sul comportamento di CLI.
dependencies string[] No Nomi dei blocchi dello stesso registro che devono essere installati insieme a questo blocco.
files string[] Sì Percorsi dei file relativi alla cartella del blocco. È richiesto almeno un file.

Risoluzione dei file

Ogni file viene scaricato da:

Codice
{baseUrl}/{block.name}/{file}

E scritto in:

Codice
{directory}/{block.name}/{file}

Le sottodirectory nei percorsi dei file vengono create automaticamente.

Regole di convalida

  • name non deve essere vuoto né a livello di registro né a livello di blocco.
  • baseUrl deve essere un URL valido.
  • blocks deve contenere almeno una voce.
  • files di ogni blocco deve contenere almeno una voce.
  • Se specificato, type deve essere uno dei tre valori consentiti.
  • Se specificato, dependencies deve essere un array di stringhe. Ogni dipendenza deve esistere nello stesso registro, altrimenti il CLI genererà un errore durante la risoluzione.