Перейти до вмісту

Схема registry.json

Повна схема

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

Поля верхнього рівня

Поле Тип Обов’язкове Опис
$schema string Ні Схема JSON URL для перевірки редактором.
name string Так Ідентифікатор реєстру. Не може бути порожнім.
description string Ні Короткий опис реєстру.
baseUrl string Так Базова URL для завантаження файлів блоків. Має бути дійсною URL.
blocks BlockEntry[] Так Масив доступних блоків. Має містити принаймні один запис.

Поля запису блоку

Поле Тип Обов’язкове Опис
name string Так Назва теки блоку й ідентифікатор CLI. Не може бути порожнім.
title string Ні Зрозуміла користувачам назва для відображення.
description string Ні Однорядковий опис для результатів пошуку.
category string Ні Назва групи у списку.
type "blockstudio" | "create-block" | "wordpress" Ні Тип блоку. Лише для довідки, не впливає на поведінку CLI.
dependencies string[] Ні Назви блоків у тому самому реєстрі, які потрібно встановити разом із цим блоком.
files string[] Так Шляхи до файлів відносно теки блоку. Потрібен принаймні один файл.

Визначення шляхів до файлів

Кожен файл завантажується з:

Код
{baseUrl}/{block.name}/{file}

І записується до:

Код
{directory}/{block.name}/{file}

Підкаталоги у шляхах файлів створюються автоматично.

Правила перевірки

  • name мають бути непорожніми як на рівні реєстру, так і блоку.
  • baseUrl має бути дійсним URL.
  • blocks має містити принаймні один запис.
  • files кожного блоку має містити принаймні один запис.
  • Якщо вказано type, воно має бути одним із трьох дозволених значень.
  • Якщо вказано dependencies, воно має бути масивом рядків. Кожна залежність має існувати в тому самому реєстрі, інакше під час розв’язання залежностей CLI видасть помилку.