Към съдържанието

Схема на 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 ще изведе грешка при разрешаването ѝ.