Kezdő lépések
Előfeltételek
- Node.js 18+
- Egy WordPress téma vagy bővítmény, amelybe blokkokat szeretnél telepíteni
A npm csomag blockstudio verziója: 0.0.1. Ez a kiadás csak egy helyőrző: mindössze egy add parancsot tartalmaz, amely kiírja ezt: Adding block: <name>, majd adatlekérés nélkül kilép. Ismeretlenként elutasítja a következőket: init, list, search, remove, --yes és --dry-run. Az ezen az oldalon bemutatott parancsok a Blockstudio tárolóban található CLI regisztert írják le (packages/registry).
A projekt inicializálása
Futtasd ezt: init a témád vagy bővítményed gyökérkönyvtárában:
npx blockstudio init
A CLI végigvezet egy interaktív beállításon:
- Blokkkönyvtár: ahová a blokkok települnek (alapértelmezés:
blockstudio) - Regiszterek: név alapján egy vagy több regiszter-URL hozzáadása
Ezzel létrejön egy blocks.json fájl:
{
"$schema": "https://blockstudio.dev/schema/blocks.json",
"directory": "blockstudio",
"registries": {
"ui": "https://blocks.example.com/registry.json"
}
}
Az interaktív kérdések kihagyása is lehetséges:
npx blockstudio init --yes
Ezzel létrejön egy alapértelmezett értékeket tartalmazó blocks.json. Ezután kézzel is szerkesztheted.
Blokk hozzáadása
npx blockstudio add ui/tabs
A formátum: namespace/block, ahol a namespace a registries konfiguráció kulcsának felel meg.
A CLI:
- Lekéri a regisztert
- Megkeresi a blokkot
- Feloldja a függőségeket (e.g. A
tabsfügg atab-itemblokktól.) - Letölti az összes fájlt
- A fájlokat a blokkkönyvtárba írja
Ha a blokk csak egy regiszterben található meg, a névteret elhagyhatod:
npx blockstudio add tabs
Ha több regiszterben is megtalálható, a CLI terminálon megkér, hogy válassz. Terminál nélkül egy hibaüzenetben felsorolja az egyező regisztereket, majd leáll; a --yes kapcsolóval pedig a blocks.json sorrendjében elsőként szereplő regisztert választja.
Több blokk hozzáadása
npx blockstudio add ui/tabs ui/hero ui/accordion
Az összes blokk egyetlen futás során települ.
Előnézet telepítés előtt
npx blockstudio add ui/tabs --dry-run
Megmutatja, hogy mi települne fájlok írása nélkül.
Elérhető blokkok böngészése
npx blockstudio list
npx blockstudio list ui
npx blockstudio search hero
A list az összes regiszter összes blokkját (vagy egy adott regiszteréit) jeleníti meg. A search a blokknevekben, címekben és leírásokban keres, kis- és nagybetűket nem megkülönböztető részszöveg-egyezéssel.
Blokk eltávolítása
npx blockstudio remove tabs
Törli a blokkmappát. Interaktív módban megerősítést kér. A kérdés kihagyásához add meg ezt: --yes.
CI és automatizálás
A init, add és remove parancsok elfogadják ezt: --yes. Ezzel kihagyhatók az interaktív kérdések.
A list és a search soha nem kérdez, és ismeretlen beállításként elutasítja ezt: --yes.
Ha a szabványos bemenet nem terminál (például CI-futtatókban vagy átirányított bemenet esetén), a CLI nem interaktív módra vált: a init felülírja a meglévő blocks.json fájlt, a add hibaüzenettel leáll, ha egy blokkmappa már létezik vagy a blokk neve kétértelmű, a remove pedig kérdezés nélkül töröl.
npx blockstudio init --yes --directory blockstudio
npx blockstudio add ui/tabs --yes
npx blockstudio remove tabs --yes