Preskočiť na obsah

Schéma registry.json

Úplná schéma

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

Polia najvyššej úrovne

Pole Typ Povinné Opis
$schema string Nie Schéma JSON URL na overovanie v editore.
name string Áno Identifikátor registra. Nesmie byť prázdny.
description string Nie Stručný opis registra.
baseUrl string Áno Základná adresa URL na sťahovanie súborov blokov. Musí ísť o platnú adresu URL.
blocks BlockEntry[] Áno Zoznam dostupných blokov. Musí obsahovať aspoň jednu položku.

Polia položky bloku

Pole Typ Povinné Opis
name string Áno Názov priečinka bloku a identifikátor CLI. Nesmie byť prázdny.
title string Nie Zobrazovaný názov pre používateľa.
description string Nie Jednoriadkový opis vo výsledkoch vyhľadávania.
category string Nie Označenie skupiny vo výstupe zoznamu.
type "blockstudio" | "create-block" | "wordpress" Nie Typ bloku. Má len informačný účel a nemení správanie CLI.
dependencies string[] Nie Názvy blokov v rovnakom registri, ktoré sa musia nainštalovať spolu s týmto blokom.
files string[] Áno Cesty k súborom relatívne k priečinku bloku. Vyžaduje sa aspoň jeden súbor.

Rozpoznávanie súborov

Každý súbor sa stiahne z adresy:

Kód
{baseUrl}/{block.name}/{file}

A zapíše sa do:

Kód
{directory}/{block.name}/{file}

Podadresáre v cestách k súborom sa vytvárajú automaticky.

Pravidlá overovania

  • name nesmie byť prázdny na úrovni registra ani bloku.
  • baseUrl musí byť platná adresa URL.
  • blocks musí obsahovať aspoň jednu položku.
  • files každého bloku musí obsahovať aspoň jednu položku.
  • Ak je type uvedené, musí ísť o jednu z troch povolených hodnôt.
  • Ak je dependencies uvedené, musí ísť o zoznam reťazcov. Každá závislosť musí existovať v tom istom registri, inak CLI pri jej riešení vyvolá chybu.