Pereiti prie turinio

Registro talpinimas

Registrą sudaro registry.json failas ir blokų aplankų rinkinys, pateikiami per HTTP. Specialaus serverio nereikia. Tinka bet kuri paslauga, galinti pateikti statinius failus.

Ko reikia

  1. registry.json failo, kuriame išvardyti jūsų blokai
  2. Blokų aplankų su manifeste nurodytais failais
  3. Žiniatinklio serverio arba talpinimo paslaugos, kuri pateikia abu šiuos elementus

Katalogų struktūra

Tipinė registro saugykla atrodo taip:

Kodas
my-registry/
  registry.json
  blocks/
    hero/
      block.json
      index.php
      style.scss
    tabs/
      block.json
      index.php
      style.scss
    tab-item/
      block.json
      index.php

registry.json nurodo katalogą blocks/ kaip savo baseUrl:

JSON
{
  "name": "my-registry",
  "baseUrl": "https://example.com/blocks",
  "blocks": [
    {
      "name": "hero",
      "title": "Hero",
      "files": ["block.json", "index.php", "style.scss"]
    }
  ]
}

Reikalavimai

Talpinimo paslauga turi palaikyti tiesioginę failų prieigą per URL. CLI gauna failus sudarydamas URL adresus pagal {baseUrl}/{block.name}/{file}.

CLI neturi atskiro prisijungimo proceso. Privačiuose registruose prieigos kontrolę tvarkykite prieglobos lygmenyje (e.g. privačios GitHub saugyklos su prieigos žetonais arba serveris, kuris tikrina prisijungimo duomenis), o naudotojų programoms nurodykite siųsti prisijungimo duomenis kaip tinkintas antraštes per objekto formatą, aprašytą dokumentacijojeblocks.json.

Registro bandymas

Prieš paskelbdami išbandykite vietoje, paleidę paprastą HTTP serverį:

Shell
cd my-registry
npx serve .

Tada nustatykite blocks.json į http://localhost:3000/registry.json ir paleiskite npx blockstudio list, kad patikrintumėte, ar viskas randama. list gauna tik registry.json. Norėdami išbandyti add, bandymo metu nustatykite baseUrl į http://localhost:3000/blocks, nes CLI blokų failus atsisiunčia iš baseUrl.