Liigu sisu juurde

registry.json

registry.json on serveris URL hostitud JSON fail. Selles on loetletud kõik registris saadaolevad plokid, nende metaandmed, sõltuvused ja failide manifestid.

Skeem

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

Ülataseme väljad

name

Kohustuslik. Registri identifikaator. CLI valideerib selle, kuid ei kuva seda: käskudes ja väljundis kasutatakse registri jaoks tarbija valitud võtit failis blocks.json.

description

Valikuline. Lühikirjeldus registri sisu kohta.

baseUrl

Kohustuslik. Plokifailide allalaadimise alus-URL. See peab olema kehtiv URL.

Failide hankimiseks liidetakse alus-URL, ploki nimi ja faili tee: {baseUrl}/{block.name}/{file}.

Näiteks kui baseUrl väärtus on https://raw.githubusercontent.com/acme/blocks/main/blocks ning ploki nimi on tabs ja faili nimi index.php, hangib CLI järgmise faili:

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

Ploki väljad

name

Kohustuslik. Ploki kausta nimi. Seda tunnust kasutatakse CLI käskudes ja sellest saab kettal kausta nimi.

title

Valikuline. Inimloetav nimi, mida kuvatakse list ja search väljundis.

description

Valikuline. Üherealine kirjeldus, mida kuvatakse search tulemustes.

category

Valikuline. Rühmitussilt list väljundi jaoks.

type

Valikuline. Üks järgmistest: blockstudio, create-block või wordpress.

See on ainult teavitav teave. CLI ei muuda käitumist ploki tüübi põhjal. See laadib alati alla ja kopeerib failid, mis on loetletud files-s.

dependencies

Valikuline. Massiiv teiste sama registri plokkide nimedest, mis tuleb selle ploki kõrval installida.

Kui kasutaja lisab sõltuvustega ploki, lahendab CLI kogu sõltuvuspuu ja installib kõik õiges järjekorras. Ringtsüklilised sõltuvused tuvastatakse ja nende korral väljastatakse veateade.

Sõltuvused peavad olema samas registris. Registritevahelisi sõltuvusi ei toetata.

files

Kohustuslik. Failiteede massiiv ploki kausta suhtes. Nõutav on vähemalt üks fail.

Need on täpsed failid, mille CLI alla laadib ja kettale kirjutab. Teed võivad sisaldada alamkatalooge:

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

Failide lahendamine

Iga ploki manifestis oleva faili jaoks koostab CLI allalaadimise URL:

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

Ja kirjutab selle asukohta:

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

Ploki kaustasisene kataloogistruktuur säilib. Kui failitee sisaldab alamkatalooge, luuakse need automaatselt.

Failid hangitakse alati asukohast baseUrl, mis asub registry.json sees, mitte asukohast, mis on suhteline registri URL asukohaga failis blocks.json.

Valideerimine

Iga hankimise ajal valideerib CLI väärtuse registry.json skeemi Zod alusel. Vigaste registrite puhul kuvatakse selged veateated koos valideerimisel ebaõnnestunud väljadega.

Puuduvad kohustuslikud väljad, tühjad blocks või files massiivid, vigased URL-id ja tundmatud väärtused type tuvastatakse enne failide allalaadimist.