Ugrás a tartalomhoz

Nyilvántartás üzemeltetése

A nyilvántartás egy registry.json fájlból és a blokkok mappáiból áll, amelyeket HTTP-n keresztül szolgálnak ki. Nincs szükség külön szerverre. Bármilyen statikus fájlokat kiszolgáló megoldás megfelel.

Amire szükséged van

  1. Egy registry.json fájl, amely felsorolja a blokkokat
  2. Blokkmappák a jegyzékben hivatkozott fájlokkal
  3. Egy webszerver vagy tárhelyszolgáltatás, amely mindkettőt kiszolgálja

Könyvtárszerkezet

Egy tipikus nyilvántartástárhely így néz ki:

Kód
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

A registry.json a blocks/ könyvtárat adja meg baseUrl-ként:

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

Követelmények

A tárhelynek támogatnia kell a fájlok közvetlen elérését URL útján. A CLI az {baseUrl}/{block.name}/{file} alapján összeállított URL-ekkel tölti le a fájlokat.

A CLI nem rendelkezik saját bejelentkezési folyamattal. Privát nyilvántartásoknál a hozzáférés-vezérlést a tárhely szintjén kezeld (e.g. például privát GitHub tárhelyek tokenekkel, vagy egy hitelesítő adatokat ellenőrző szerver), a felhasználók pedig az objektumformátumon keresztül küldjék el a hitelesítő adatokat egyéni fejlécekben: blocks.json.

A nyilvántartás tesztelése

Közzététel előtt teszteld helyben egy egyszerű HTTP szerver elindításával:

Shell
cd my-registry
npx serve .

Ezután irányítsa a(z) blocks.json elemet a(z) http://localhost:3000/registry.json címre, és futtassa a(z) npx blockstudio list parancsot annak ellenőrzéséhez, hogy minden feloldódik-e. A(z) list csak a(z) registry.json elemet tölti le. A(z) add teszteléséhez állítsa a(z) baseUrl értékét erre: http://localhost:3000/blocks a tesztelés idejére, mert a(z) CLI letöltései blokkolják a(z) baseUrl fájljait.