Začetek
Predpogoji
- Node.js 18+
- Tema ali vtičnik WordPress, v katerega želite namestiti bloke
Paket blockstudio na npm je v različici 0.0.1. Ta izdaja je samo začasna: vsebuje le ukaz add, ki izpiše Adding block: <name> in se konča, ne da bi karkoli prenesel, obenem pa kot neznane zavrne možnosti init, list, search, remove, --yes in --dry-run. Ukazi na teh straneh opisujejo register CLI v repozitoriju Blockstudio (packages/registry).
Inicializirajte projekt
V korenski mapi teme ali vtičnika zaženite init:
npx blockstudio init
CLI vas vodi skozi interaktivno nastavitev:
- Imenik blokov: kam naj se namestijo bloki (privzeto:
blockstudio) - Registri: po imenu dodajte enega ali več URL-jev registrov
S tem se ustvari datoteka blocks.json:
{
"$schema": "https://blockstudio.dev/schema/blocks.json",
"directory": "blockstudio",
"registries": {
"ui": "https://blocks.example.com/registry.json"
}
}
Interaktivne pozive lahko tudi preskočite:
npx blockstudio init --yes
S tem se ustvarita datoteka blocks.json in privzete vrednosti. Pozneje jo lahko ročno uredite.
Dodajanje bloka
npx blockstudio add ui/tabs
Oblika je namespace/block, kjer se namespace ujema s ključem v vaši konfiguraciji registries.
CLI:
- Pridobi podatke iz registra
- Poišče blok
- Razreši morebitne odvisnosti (e.g.
tabsje odvisen odtab-item) - Prenese vse datoteke
- Zapiše jih v imenik blokov
Če blok obstaja samo v enem registru, lahko izpustite imenski prostor:
npx blockstudio add tabs
Če obstaja v več registrih, vas CLI v terminalu pozove k izbiri. Brez terminala se ustavi z napako, ki navede ustrezne registre; možnost --yes pa izbere prvega po vrstnem redu blocks.json.
Dodajanje več blokov
npx blockstudio add ui/tabs ui/hero ui/accordion
Vsi bloki se namestijo v enem zagonu.
Predogled pred namestitvijo
npx blockstudio add ui/tabs --dry-run
Prikaže, kaj bi bilo nameščeno, ne da bi zapisalo datoteke.
Brskanje po razpoložljivih blokih
npx blockstudio list
npx blockstudio list ui
npx blockstudio search hero
list prikaže vse bloke iz vseh registrov (ali iz določenega registra). search išče podniz v imenih, naslovih in opisih blokov, pri čemer ne razlikuje med velikimi in malimi črkami.
Odstranjevanje bloka
npx blockstudio remove tabs
Izbriše mapo bloka. V interaktivnem načinu vas pozove k potrditvi. Z možnostjo --yes poziv preskočite.
CI in avtomatizacija
Ukazi init, add in remove sprejemajo --yes za preskok interaktivnih pozivov. Ukaza list in search nikoli ne prikažeta poziva in zavrneta --yes kot neznano možnost. Ko stdin ni terminal (izvajalniki CI ali vhod prek cevi), CLI preide v neinteraktivni način: init prepiše obstoječi blocks.json, add se ustavi z napako, če mapa bloka že obstaja ali je ime bloka dvoumno, remove pa izbriše brez vprašanja.
npx blockstudio init --yes --directory blockstudio
npx blockstudio add ui/tabs --yes
npx blockstudio remove tabs --yes