Ga naar de inhoud

Schema van registry.json

Volledig schema

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

Velden op hoofdniveau

Veld Type Vereist Beschrijving
$schema string Nee JSON-schema URL voor validatie in de editor.
name string Ja Register-ID. Mag niet leeg zijn.
description string Nee Korte beschrijving van het register.
baseUrl string Ja Basis-URL voor het downloaden van blokbestanden. Moet een geldige URL zijn.
blocks BlockEntry[] Ja Lijst met beschikbare blokken. Moet minstens één item bevatten.

Velden van blokitems

Veld Type Vereist Beschrijving
name string Ja Naam van de blokmap en CLI-ID. Mag niet leeg zijn.
title string Nee Weergavenaam voor gebruikers.
description string Nee Beschrijving van één regel voor zoekresultaten.
category string Nee Groepslabel voor lijstuitvoer.
type "blockstudio" | "create-block" | "wordpress" Nee Bloktype. Alleen ter informatie; heeft geen invloed op het gedrag van CLI.
dependencies string[] Nee Bloknamen in hetzelfde register die samen met dit blok moeten worden geïnstalleerd.
files string[] Ja Bestandspaden relatief aan de blokmap. Er is minstens één bestand vereist.

Bestanden opzoeken

Elk bestand wordt opgehaald van:

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

En opgeslagen in:

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

Submappen in bestandspaden worden automatisch aangemaakt.

Validatieregels

  • name mag niet leeg zijn, zowel op register- als blokniveau.
  • baseUrl moet een geldige URL zijn.
  • blocks moet minstens één item bevatten.
  • De files van elk blok moet minstens één item bevatten.
  • type moet, indien opgegeven, een van de drie toegestane waarden zijn.
  • dependencies moet, indien opgegeven, een lijst met tekenreeksen zijn. Elke afhankelijkheid moet in hetzelfde register bestaan, anders geeft de CLI een fout bij het oplossen.