Pereiti prie turinio

registry.json

registry.json yra JSON failas, talpinamas URL. Jame išvardyti visi registre prieinami blokai, jų metaduomenys, priklausomybės ir failų aprašai.

Schema

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

Aukščiausio lygio laukai

name

Privaloma. Registro identifikatorius. CLI jį patikrina, bet nerodo: komandose ir išvestyje naudojamas raktas, kurį vartotojas pasirinko registro konfigūracijoje blocks.json.

description

Neprivaloma. Trumpas registro turinio aprašas.

baseUrl

Privaloma. Bazinis URL, iš kurio atsisiunčiami blokų failai. Turi būti galiojantis URL.

Failai gaunami sudarant adresą iš bazinio URL, bloko pavadinimo ir failo kelio: {baseUrl}/{block.name}/{file}.

Pavyzdžiui, jei baseUrl nustatytas į https://raw.githubusercontent.com/acme/blocks/main/blocks, o bloko pavadinimas yra tabs, o failo kelias – index.php, CLI gauna:

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

Blokų laukai

name

Privaloma. Bloko aplanko pavadinimas. Šis identifikatorius naudojamas CLI komandose ir tampa aplanko pavadinimu diske.

title

Neprivaloma. Žmogui suprantamas pavadinimas, rodomas list ir search išvestyje.

description

Neprivaloma. Vienos eilutės aprašas, rodomas search rezultatuose.

category

Neprivaloma. list išvesties grupavimo žyma.

type

Neprivaloma. Viena iš šių reikšmių: blockstudio, create-block arba wordpress.

Tai tik informacinis laukas. CLI nekeičia veikimo pagal bloko tipą. Ji visada atsisiunčia ir nukopijuoja faile files nurodytus failus.

dependencies

Neprivaloma. Kitų to paties registro blokų pavadinimų, kurie turi būti įdiegti kartu su šiuo bloku, masyvas.

Kai naudotojas prideda bloką su priklausomybėmis, CLI išnagrinėja visą priklausomybių medį ir įdiegia viską tinkama tvarka. Ciklinės priklausomybės aptinkamos ir atmetamos.

Priklausomybės turi būti tame pačiame registre. Priklausomybės tarp registrų nepalaikomos.

files

Privaloma. Bloko aplanko atžvilgiu nurodytų failų kelių masyvas. Būtinas bent vienas failas.

Tai tikslūs failai, kuriuos CLI atsisiunčia ir įrašo į diską. Keliai gali apimti pakatalogius:

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

Failų parinkimas

Kiekvienam bloko apraše esančiam failui CLI sudaro atsisiuntimo URL:

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

Ir įrašo jį į:

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

Išsaugoma katalogų struktūra bloko aplanke. Jei failo kelyje yra pakatalogių, jie sukuriami automatiškai.

Failai visada gaunami iš registry.json esančio baseUrl, o ne iš vietos, santykinės su registro URL faile blocks.json.

Tikrinimas

Kiekvieną kartą gaudamas duomenis, CLI tikrina registry.json pagal Zod schemą. Netinkami registrai pateikia aiškias klaidas, kuriose nurodomi konkretūs laukų tikrinimo neatitikimai.

Prieš atsisiunčiant failus aptinkami trūkstami privalomi laukai, tušti blocks arba files masyvai, netinkami URL ir nežinomos type reikšmės.