Siirry sisältöön

Rekisterin isännöinti

Rekisteri koostuu registry.json-tiedostosta ja lohkokansioista, joita tarjotaan HTTPn kautta. Erityistä palvelinta ei tarvita. Mikä tahansa staattisia tiedostoja tarjoava palvelu käy.

Tarvittavat asiat

  1. registry.json-tiedosto, jossa lohkot luetellaan
  2. Lohkokansiot, joissa on manifestissa viitatut tiedostot
  3. Verkkopalvelin tai isännöintipalvelu, joka tarjoaa molemmat

Hakemistorakenne

Tyypillinen rekisterirepositorio näyttää tältä:

Koodi
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 osoittaa blocks/-hakemiston sen baseUrl-arvona:

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

Vaatimukset

Isännöinnin on tuettava tiedostojen suoraa käyttöä URL-osoitteella. CLI hakee tiedostot muodostamalla URL-osoitteet arvosta {baseUrl}/{block.name}/{file}.

CLIssa ei ole omaa kirjautumistoimintoa. Yksityisten rekisterien käyttöoikeuksien hallinta hoidetaan isännöintikerroksessa (e.g. yksityiset GitHub-repositoriot tunnuksilla tai tunnistetiedot tarkistavalla palvelimella), ja kuluttajien tulee lähettää tunnistetiedot mukautettuina otsakkeina objektimuodon kautta kohdassa blocks.json.

Rekisterin testaaminen

Testaa paikallisesti ennen julkaisua käynnistämällä yksinkertainen HTTP-palvelin:

Shell
cd my-registry
npx serve .

Osoita sitten blocks.json osoitteeseen http://localhost:3000/registry.json ja suorita npx blockstudio list varmistaaksesi, että kaikki löytyy. list hakee vain registry.json. Testaa add asettamalla testauksen ajaksi baseUrl arvoon http://localhost:3000/blocks, sillä CLI lataa lohkotiedostot osoitteesta baseUrl.