Siirry sisältöön

registry.json-skeema

Täysi skeema

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

Ylätason kentät

Kenttä Tyyppi Pakollinen Kuvaus
$schema string Ei JSON-skeema URL editorin validointia varten.
name string Kyllä Rekisterin tunniste. Ei saa olla tyhjä.
description string Ei Rekisterin lyhyt kuvaus.
baseUrl string Kyllä Lohkotiedostojen latauksen perus-URL. Sen on oltava kelvollinen URL.
blocks BlockEntry[] Kyllä Saatavilla olevien lohkojen taulukko. Siinä on oltava vähintään yksi kohde.

Lohkomerkinnän kentät

Kenttä Tyyppi Pakollinen Kuvaus
name string Kyllä Lohkokansion nimi ja CLI-tunniste. Ei saa olla tyhjä.
title string Ei Ihmiselle luettava näyttönimi.
description string Ei Yhden rivin kuvaus hakutuloksia varten.
category string Ei Ryhmittelyn nimi listatulosteessa.
type "blockstudio" | "create-block" | "wordpress" Ei Lohkon tyyppi. Vain tiedoksi, ei vaikuta CLIn toimintaan.
dependencies string[] Ei Saman rekisterin lohkojen nimet, jotka on asennettava tämän lohkon kanssa.
files string[] Kyllä Tiedostopolut suhteessa lohkokansioon. Vähintään yksi tiedosto vaaditaan.

Tiedostojen polkujen ratkaiseminen

Kukin tiedosto ladataan osoitteesta:

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

Ja kirjoitetaan kohteeseen:

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

Tiedostopolkujen alihakemistot luodaan automaattisesti.

Validointisäännöt

  • namen on oltava ei-tyhjä sekä rekisteri- että lohkotasolla.
  • baseUrln on oltava kelvollinen URL.
  • blocksn on sisällettävä vähintään yksi kohde.
  • Kunkin lohkon filesn on sisällettävä vähintään yksi kohde.
  • Jos type on annettu, sen on oltava yksi kolmesta sallitusta arvosta.
  • Jos dependencies on annettu, sen on oltava merkkijonotaulukko. Kunkin riippuvuuden on löydyttävä samasta rekisteristä, tai CLI antaa virheen riippuvuuksia ratkaistaessa.