Začínáme
Požadavky
- Node.js verze 18 nebo novější
- Šablona nebo plugin WordPress, do kterého chcete instalovat bloky
Balíček blockstudio na npm je ve verzi 0.0.1. Tato verze je pouze zástupná: obsahuje jen příkaz add, který vypíše Adding block: <name> a skončí bez stahování, a neznámé odmítne volby init, list, search, remove, --yes a --dry-run. Příkazy na těchto stránkách popisují rozhraní registru CLI v repozitáři Blockstudio (packages/registry).
Inicializace projektu
Spusťte init v kořenovém adresáři šablony nebo pluginu:
npx blockstudio init
CLI vás provede interaktivním nastavením:
- Adresář bloků: kam se mají bloky instalovat (výchozí:
blockstudio) - Registry: přidejte jeden nebo více registrů pomocí jejich URL a názvu
Vytvoří se soubor blocks.json:
{
"$schema": "https://blockstudio.dev/schema/blocks.json",
"directory": "blockstudio",
"registries": {
"ui": "https://blocks.example.com/registry.json"
}
}
Interaktivní výzvy můžete také přeskočit:
npx blockstudio init --yes
Vytvoří se soubor blocks.json s výchozím nastavením. Poté jej můžete ručně upravit.
Přidání bloku
npx blockstudio add ui/tabs
Formát je namespace/block, kde namespace odpovídá klíči v konfiguraci registries.
CLI:
- Načte registr
- Najde blok
- Vyřeší případné závislosti (e.g.
tabszávisí natab-item) - Stáhne všechny soubory
- Zapíše je do adresáře vašeho bloku
Pokud se blok nachází jen v jednom registru, můžete jmenný prostor vynechat:
npx blockstudio add tabs
Pokud se nachází ve více registrech, CLI vás v terminálu vyzve k výběru. Bez terminálu skončí chybou se seznamem odpovídajících registrů. Volba --yes vybere první registr v pořadí blocks.json.
Přidání více bloků
npx blockstudio add ui/tabs ui/hero ui/accordion
Všechny bloky se nainstalují během jednoho běhu.
Náhled před instalací
npx blockstudio add ui/tabs --dry-run
Zobrazí se, co by se nainstalovalo, aniž by se zapsaly nějaké soubory.
Procházení dostupných bloků
npx blockstudio list
npx blockstudio list ui
npx blockstudio search hero
list zobrazí všechny bloky ze všech registrů, případně jen z vybraného registru. search hledá podřetězec bez rozlišování velkých a malých písmen v názvech, titulcích a popisech bloků.
Odstranění bloku
npx blockstudio remove tabs
Odstraní složku bloku. V interaktivním režimu budete požádáni o potvrzení. Chcete-li tuto výzvu přeskočit, zadejte --yes.
CI a automatizace
Příkazy init, add a remove přijímají --yes pro přeskočení interaktivních výzev. Příkazy list a search se nikdy neptají a odmítnou --yes jako neznámou volbu. Pokud stdin není terminál (běžci CI, přesměrovaný vstup), CLI přejde do neinteraktivního režimu: init přepíše existující blocks.json, add skončí chybou, pokud složka bloku již existuje nebo je název bloku nejednoznačný, a remove odstraní blok bez dotazu.
npx blockstudio init --yes --directory blockstudio
npx blockstudio add ui/tabs --yes
npx blockstudio remove tabs --yes