Preskočiť na obsah

Začíname

Predpoklady

  • Node.js verzie 18 alebo novšia
  • Téma alebo plugin WordPress, do ktorého chcete nainštalovať bloky

Balík blockstudio na npm má verziu 0.0.1. Toto vydanie je iba zástupné: obsahuje len príkaz add, ktorý vypíše Adding block: <name> a skončí bez načítania čohokoľvek; ako neznáme odmieta možnosti init, list, search, remove, --yes a --dry-run. Príkazy na týchto stránkach opisujú register CLI v repozitári Blockstudio (packages/registry).

Inicializácia projektu

Spustite init v koreňovom adresári témy alebo pluginu:

Shell
npx blockstudio init

CLI vás prevedie interaktívnym nastavením:

  1. Adresár blokov: kam sa majú bloky nainštalovať (predvolené: blockstudio)
  2. Registre: pridajte jeden alebo viac registrov podľa názvu a adresy URL

Vytvorí sa súbor blocks.json:

JSON
{
  "$schema": "https://blockstudio.dev/schema/blocks.json",
  "directory": "blockstudio",
  "registries": {
    "ui": "https://blocks.example.com/registry.json"
  }
}

Interaktívne výzvy môžete aj preskočiť:

Shell
npx blockstudio init --yes

Tým sa vytvorí súbor blocks.json s predvolenými hodnotami. Neskôr ho môžete upraviť ručne.

Pridanie bloku

Shell
npx blockstudio add ui/tabs

Formát je namespace/block, pričom namespace zodpovedá kľúču v konfigurácii registries.

CLI:

  1. Načíta register
  2. Nájde blok
  3. Rozpozná prípadné závislosti (e.g. tabs závisí od tab-item)
  4. Stiahne všetky súbory
  5. Zapíše ich do adresára blokov

Ak blok existuje iba v jednom registri, menný priestor môžete vynechať:

Shell
npx blockstudio add tabs

Ak existuje vo viacerých registroch, CLI vás v termináli vyzve na výber. Bez terminálu sa zastaví a vypíše chybu so zoznamom zodpovedajúcich registrov; --yes vyberie prvý v poradí blocks.json.

Pridanie viacerých blokov

Shell
npx blockstudio add ui/tabs ui/hero ui/accordion

Všetky bloky sa nainštalujú v rámci jedného spustenia.

Náhľad pred inštaláciou

Shell
npx blockstudio add ui/tabs --dry-run

Zobrazí sa, čo by sa nainštalovalo, bez zápisu súborov.

Prehľad dostupných blokov

Shell
npx blockstudio list
npx blockstudio list ui
npx blockstudio search hero

list zobrazí všetky bloky zo všetkých registrov (alebo z konkrétneho registra). search vyhľadáva podreťazec bez rozlišovania veľkých a malých písmen v názvoch, tituloch a popisoch blokov.

Odstránenie bloku

Shell
npx blockstudio remove tabs

Odstráni sa priečinok bloku. V interaktívnom režime sa zobrazí výzva na potvrdenie. Ak chcete výzvu preskočiť, zadajte --yes.

CI a automatizácia

init, add a remove podporujú možnosť --yes na preskočenie interaktívnych výziev. list a search výzvy nikdy nezobrazujú a možnosť --yes odmietnu ako neznámu. Keď stdin nie je terminál (spúšťače CI, presmerovaný vstup), CLI prejde do neinteraktívneho režimu: init prepíše existujúci súbor blocks.json, add sa zastaví s chybou, ak už priečinok bloku existuje alebo je názov bloku nejednoznačný, a remove odstráni blok bez opýtania.

Shell
npx blockstudio init --yes --directory blockstudio
npx blockstudio add ui/tabs --yes
npx blockstudio remove tabs --yes