Preskoči na vsebino

registry.json

registry.json je datoteka JSON, gostovana na URL. Navaja vse razpoložljive bloke v registru, njihove metapodatke, odvisnosti in manifesta datotek.

Shema

JSON
{
  "$schema": "https://blockstudio.dev/schema/registry.json",
  "name": "ui",
  "description": "Core UI blocks for Blockstudio projects.",
  "baseUrl": "https://raw.githubusercontent.com/acme/blocks/main/blocks",
  "blocks": [
    {
      "name": "tabs",
      "title": "Tabs",
      "description": "Tabbed content with accessible keyboard navigation.",
      "category": "layout",
      "type": "blockstudio",
      "dependencies": ["tab-item"],
      "files": [
        "block.json",
        "index.php",
        "style.scss"
      ]
    }
  ]
}

Polja na najvišji ravni

name

Obvezno. Identifikator registra. CLI ga preveri, vendar ga ne prikaže: ukazi in izpis uporabljajo ključ, ki ga je uporabnik izbral za register v blocks.json.

description

Izbirno. Kratek opis vsebine tega registra.

baseUrl

Obvezno. Osnovni URL za prenos datotek blokov. Biti mora veljaven URL.

Datoteke se pridobijo tako, da se osnovni URL združi z imenom bloka in potjo do datoteke: {baseUrl}/{block.name}/{file}.

Če je na primer baseUrl nastavljen na https://raw.githubusercontent.com/acme/blocks/main/blocks, blok pa se imenuje tabs in vsebuje datoteko index.php, CLI pridobi:

Koda
https://raw.githubusercontent.com/acme/blocks/main/blocks/tabs/index.php

Polja bloka

name

Obvezno. Ime mape bloka. Ta identifikator se uporablja v ukazih CLI in postane ime mape na disku.

title

Izbirno. Berljivo ime, prikazano v izpisu list in search.

description

Izbirno. Enovrstični opis, prikazan med rezultati search.

category

Izbirna oznaka za razvrščanje izpisa list v skupine.

type

Izbirno. Ena od vrednosti blockstudio, create-block ali wordpress.

To je zgolj informativno. CLI ne spreminja delovanja glede na vrsto bloka. Vedno prenese in kopira datoteke, navedene v files.

dependencies

Izbirno. Polje z imeni drugih blokov v istem registru, ki jih je treba namestiti skupaj s tem blokom.

Ko uporabnik doda blok z odvisnostmi, CLI razreši celotno drevo odvisnosti in vse namesti v pravilnem vrstnem redu. Krožne odvisnosti se zaznajo in zavrnejo.

Odvisnosti morajo obstajati v istem registru. Odvisnosti med registri niso podprte.

files

Obvezno. Polje poti do datotek, relativnih na mapo bloka. Potrebna je vsaj ena datoteka.

To so točne datoteke, ki jih CLI prenese in zapiše na disk. Poti lahko vključujejo podmape:

JSON
{
  "files": [
    "block.json",
    "index.php",
    "style.scss",
    "src/components/tabs.tsx",
    "src/styles/tabs.css"
  ]
}

Razreševanje poti datotek

Za vsako datoteko v manifestu bloka CLI sestavi URL za prenos URL:

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

In jo zapiše v:

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

Struktura imenikov v mapi bloka se ohrani. Če pot do datoteke vsebuje podmape, se te ustvarijo samodejno.

Datoteke se vedno pridobijo z naslova baseUrl znotraj registry.json, ne s poti, relativne na register URL v blocks.json.

Preverjanje veljavnosti

CLI ob vsakem pridobivanju preveri registry.json glede na shemo Zod. Neveljavni registri povzročijo razumljiva sporočila o napakah z navedbo polj, pri katerih preverjanje ni uspelo.

Manjkajoča obvezna polja, prazna polja blocks ali polja files v obliki polja, neveljavni URL-ji in neznane vrednosti type se zaznajo pred prenosom datotek.