Siirry sisältöön

registry.json

registry.json on JSON-tiedosto, jota isännöi URL. Se luettelee kaikki rekisterin lohkot, niiden metatiedot, riippuvuudet ja tiedostoluettelot.

Skeema

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

Ylätason kentät

name

Pakollinen. Rekisterin tunniste. CLI tarkistaa sen kelvollisuuden mutta ei näytä sitä: komennoissa ja tulosteessa käytetään avainta, jonka käyttäjä valitsi rekisterille kohdassa blocks.json.

description

Valinnainen. Lyhyt kuvaus rekisterin sisällöstä.

baseUrl

Pakollinen. Lohkotiedostojen latauksen pohja-URL. Sen on oltava kelvollinen URL.

Tiedostot haetaan yhdistämällä pohja-URL, lohkon nimi ja tiedostopolku: {baseUrl}/{block.name}/{file}.

Jos esimerkiksi baseUrl on https://raw.githubusercontent.com/acme/blocks/main/blocks, lohkon nimi on tabs ja tiedosto on index.php, CLI hakee:

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

Lohkon kentät

name

Pakollinen. Lohkon kansion nimi. Tätä tunnistetta käytetään CLI-komennoissa, ja siitä tulee levyllä olevan kansion nimi.

title

Valinnainen. Ihmisluettava nimi, joka näytetään komennoissa list ja tulosteessa search.

description

Valinnainen. Yhden rivin kuvaus, joka näytetään search-tuloksissa.

category

Valinnainen. Ryhmittelytunniste kohteen list tulosteelle.

type

Valinnainen. Yksi arvoista blockstudio, create-block tai wordpress.

Tämä on vain tiedoksi. CLI ei muuta toimintaansa lohkotyypin perusteella. Se lataa ja kopioi aina kohteessa files luetellut tiedostot.

dependencies

Valinnainen. Taulukko muiden saman rekisterin lohkojen nimistä, jotka on asennettava tämän lohkon yhteydessä.

Kun käyttäjä lisää lohkon, jolla on riippuvuuksia, CLI ratkaisee koko riippuvuuspuun ja asentaa kaiken oikeassa järjestyksessä. Kehäriippuvuudet havaitaan ja hylätään.

Riippuvuuksien on oltava samassa rekisterissä. Rekisterien välisiä riippuvuuksia ei tueta.

files

Pakollinen. Taulukko tiedostopoluista suhteessa lohkokansioon. Vähintään yksi tiedosto vaaditaan.

Nämä ovat täsmälliset tiedostot, jotka CLI lataa ja kirjoittaa levylle. Polut voivat sisältää alihakemistoja:

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

Tiedostojen polkujen ratkaiseminen

Kullekin lohkon manifestissa olevalle tiedostolle CLI muodostaa lataus-URL:

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

Ja kirjoittaa sen kohteeseen:

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

Lohkokansion sisäinen hakemistorakenne säilytetään. Jos tiedostopolku sisältää alihakemistoja, ne luodaan automaattisesti.

Tiedostot haetaan aina kohteen registry.json sisältä baseUrl, ei suhteessa kohdassa blocks.json olevaan rekisterin URL-sijaintiin.

Validointi

CLI tarkistaa kohteen registry.json Zod-skeemaa vasten jokaisen haun yhteydessä. Virheellisistä rekistereistä annetaan selkeät virheilmoitukset, joissa kerrotaan tarkistuksessa epäonnistuneet kentät.

Puuttuvat pakolliset kentät, tyhjät blocks– tai files-taulukot, virheelliset URL-osoitteet ja tuntemattomat type-arvot havaitaan ennen tiedostojen lataamista.