Схема 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 выдаст ошибку при разрешении зависимостей.