Pāriet uz saturu

Reģistra mitināšana

Reģistrs ir registry.json fails un bloku mapju kopa, kas tiek nodrošināta, izmantojot HTTP. Īpašs serveris nav nepieciešams. Der jebkurš risinājums, kas var nodrošināt statiskus failus.

Nepieciešamais

  1. registry.json fails ar jūsu bloku sarakstu
  2. Bloku mapes ar manifestā norādītajiem failiem
  3. Tīmekļa serveris vai mitināšanas pakalpojums, kas nodrošina abus

Direktoriju struktūra

Tipisks reģistra repozitorijs izskatās šādi:

Kods
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 norāda blocks/ direktoriju kā savu baseUrl:

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

Prasības

Mitināšanas risinājumam jāatbalsta tieša piekļuve failiem, izmantojot URL. CLI iegūst failus, veidojot URL no {baseUrl}/{block.name}/{file}.

CLI nav sava pieteikšanās procesa. Privātiem reģistriem piekļuves kontroli nodrošiniet mitināšanas slānī (e.g, piemēram, privātiem GitHub repozitorijiem ar pilnvarām, vai serverī, kas pārbauda akreditācijas datus) un lieciet patērētājiem nosūtīt akreditācijas datus kā pielāgotas galvenes, izmantojot objektu formātu, kas aprakstīts sadaļā blocks.json.

Reģistra testēšana

Pirms publicēšanas testējiet lokāli, palaižot vienkāršu HTTP serveri:

Apvalks
cd my-registry
npx serve .

Pēc tam norādiet blocks.json uz http://localhost:3000/registry.json un palaidiet npx blockstudio list, lai pārbaudītu, vai viss tiek atrasts. list iegūst tikai registry.json. Lai testētu add, testēšanas laikā iestatiet baseUrl uz http://localhost:3000/blocks, jo CLI lejupielādē bloku failus no baseUrl.