Gå til indhold

registry.json-skema

Komplet skema

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

Felter på øverste niveau

Felt Type Påkrævet Beskrivelse
$schema string Nej JSON-skema URL til validering i editoren.
name string Ja Registeridentifikator. Må ikke være tom.
description string Nej Kort beskrivelse af registret.
baseUrl string Ja Grundlæggende URL til download af blokfiler. Skal være en gyldig URL.
blocks BlockEntry[] Ja Liste over tilgængelige blokke. Skal indeholde mindst ét element.

Felter for blokindgange

Felt Type Påkrævet Beskrivelse
name string Ja Mappenavn og CLI-identifikator for blokken. Må ikke være tom.
title string Nej Læsevenligt visningsnavn.
description string Nej Beskrivelse på én linje til søgeresultater.
category string Nej Grupperingsetiket til listevisning.
type "blockstudio" | "create-block" | "wordpress" Nej Bloktype. Kun til orientering; påvirker ikke CLIs funktionsmåde.
dependencies string[] Nej Bloknavne i det samme register, som skal installeres sammen med denne blok.
files string[] Ja Filstier relative til blokmappen. Mindst én fil kræves.

Filopløsning

Hver fil downloades fra:

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

Og skrives til:

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

Undermapper i filstier oprettes automatisk.

Valideringsregler

  • name må ikke være tomt, hverken på register- eller blokniveau.
  • baseUrl skal være en gyldig URL.
  • blocks skal indeholde mindst ét element.
  • Hver blok skal have mindst ét element i files.
  • Hvis type angives, skal værdien være en af de tre tilladte.
  • Hvis dependencies angives, skal den være en liste af strenge. Hver afhængighed skal findes i det samme register, ellers opstår der en fejl, når CLI løser afhængighederne.