Hoppa till innehåll

registry.json-schema

Fullständigt 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"
      ]
    }
  ]
}

Fält på toppnivå

Fält Typ Krävs Beskrivning
$schema string Nej JSON Schema URL för validering i redigeraren.
name string Ja Registeridentifierare. Får inte vara tom.
description string Nej Kort beskrivning av registret.
baseUrl string Ja Bas-URL för nedladdning av blockfiler. Måste vara en giltig URL.
blocks BlockEntry[] Ja Lista över tillgängliga block. Måste innehålla minst en post.

Fält för blockposter

Fält Typ Krävs Beskrivning
name string Ja Blockmappens namn och CLI-identifierare. Får inte vara tomt.
title string Nej Läsbart visningsnamn.
description string Nej Enradig beskrivning för sökresultat.
category string Nej Grupperingsetikett för listutdata.
type "blockstudio" | "create-block" | "wordpress" Nej Blocktyp. Endast informativ, påverkar inte CLI-beteendet.
dependencies string[] Nej Blocknamn i samma register som måste installeras tillsammans med blocket.
files string[] Ja Filsökvägar relativt blockmappen. Minst en fil krävs.

Sökvägsupplösning för filer

Varje fil laddas ner från:

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

Och skrivs till:

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

Undermappar i filsökvägar skapas automatiskt.

Valideringsregler

  • name får inte vara tomt, varken på register- eller blocknivå.
  • baseUrl måste vara en giltig URL.
  • blocks måste innehålla minst en post.
  • files för varje block måste innehålla minst en post.
  • type måste, om det anges, vara ett av de tre tillåtna värdena.
  • dependencies måste, om det anges, vara en lista med strängar. Varje beroende måste finnas i samma register, annars ger CLI ett fel när beroenden löses.