Pāriet uz saturu

registry.json shēma

Pilnā shē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"
      ]
    }
  ]
}

Augšējā līmeņa lauki

Lauks Tips Obligāts Apraksts
$schema string Nē JSON Schema URL redaktora validācijai.
name string Jā Reģistra identifikators. Nedrīkst būt tukšs.
description string Nē Īss reģistra apraksts.
baseUrl string Jā Bāzes URL bloku failu lejupielādei. Jābūt derīgam URL.
blocks BlockEntry[] Jā Pieejamo bloku masīvs. Tajā jābūt vismaz vienam ierakstam.

Bloka ieraksta lauki

Lauks Tips Obligāts Apraksts
name string Jā Bloka mapes nosaukums un CLI identifikators. Nedrīkst būt tukšs.
title string Nē Lietotājam saprotams attēlojamais nosaukums.
description string Nē Vienas rindiņas apraksts meklēšanas rezultātiem.
category string Nē Grupas etiķete saraksta izvadei.
type "blockstudio" | "create-block" | "wordpress" Nē Bloka tips. Tikai informatīvs, neietekmē CLI darbību.
dependencies string[] Nē Tā paša reģistra bloku nosaukumi, kas jāinstalē kopā ar šo bloku.
files string[] Jā Failu ceļi attiecībā pret bloka mapi. Jānorāda vismaz viens fails.

Failu atrašana

Katrs fails tiek lejupielādēts no:

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

Un ierakstīts šeit:

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

Apakšdirektorijas failu ceļos tiek izveidotas automātiski.

Validācijas noteikumi

  • name nedrīkst būt tukšs gan reģistra, gan bloka līmenī.
  • baseUrl jābūt derīgam URL.
  • blocks jāsatur vismaz viens ieraksts.
  • Katra bloka files jāsatur vismaz viens ieraksts.
  • Ja norādīts, type jābūt vienai no trim atļautajām vērtībām.
  • Ja norādīts, dependencies jābūt virkņu masīvam. Katrai atkarībai jābūt tajā pašā reģistrā, pretējā gadījumā CLI radīs kļūdu atrisināšanas laikā.