Przejdź do treści

Schemat registry.json

Pełny schemat

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

Pola najwyższego poziomu

Pole Typ Wymagane Opis
$schema string Nie Schemat JSON URL do walidacji w edytorze.
name string Tak Identyfikator rejestru. Nie może być pusty.
description string Nie Krótki opis rejestru.
baseUrl string Tak Bazowy URL do pobierania plików bloków. Musi być prawidłowym URL.
blocks BlockEntry[] Tak Tablica dostępnych bloków. Musi zawierać co najmniej jeden wpis.

Pola wpisu bloku

Pole Typ Wymagane Opis
name string Tak Nazwa folderu bloku i identyfikator CLI. Nie może być pusty.
title string Nie Czytelna dla użytkownika nazwa wyświetlana.
description string Nie Jednowierszowy opis wyświetlany w wynikach wyszukiwania.
category string Nie Etykieta grupy dla wyniku listy.
type "blockstudio" | "create-block" | "wordpress" Nie Typ bloku. Ma charakter wyłącznie informacyjny i nie wpływa na działanie CLI.
dependencies string[] Nie Nazwy bloków w tym samym rejestrze, które należy zainstalować razem z tym blokiem.
files string[] Tak Ścieżki plików względem folderu bloku. Wymagany jest co najmniej jeden plik.

Rozpoznawanie ścieżek plików

Każdy plik jest pobierany z:

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

I zapisywany w:

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

Podkatalogi w ścieżkach plików są tworzone automatycznie.

Zasady walidacji

  • name nie może być pusty ani na poziomie rejestru, ani bloku.
  • baseUrl musi być prawidłowym URL.
  • blocks musi zawierać co najmniej jeden wpis.
  • files każdego bloku musi zawierać co najmniej jeden wpis.
  • Jeśli podano type, musi ono przyjmować jedną z trzech dozwolonych wartości.
  • Jeśli podano dependencies, musi być tablicą ciągów znaków. Każda zależność musi istnieć w tym samym rejestrze, w przeciwnym razie CLI zgłosi błąd podczas rozwiązywania zależności.