Alustamine
Eeltingimused
- Node.js 18+
- WordPress teema või plugin, kuhu soovid plokid installida
npm paketi versioon 0.0.1 on blockstudio. See väljalase on kohatäide: selles on ainult käsk add, mis prindib Adding block: <name> ja väljub midagi hankimata; tundmatuna lükatakse tagasi init, list, search, remove, --yes ja --dry-run. Nendel lehtedel kirjeldatud käsud käivad registri CLI kohta hoidlas Blockstudio (packages/registry).
Projekti lähtestamine
Käivita init oma teema või plugina juurkataloogis:
npx blockstudio init
CLI juhendab sind interaktiivses seadistuses:
- Plokkide kataloog: kuhu plokid installida (vaikimisi:
blockstudio) - Registrid: lisa üks või mitu registrit nime ja URL-i järgi
See loob faili blocks.json:
{
"$schema": "https://blockstudio.dev/schema/blocks.json",
"directory": "blockstudio",
"registries": {
"ui": "https://blocks.example.com/registry.json"
}
}
Võid ka interaktiivsed küsimused vahele jätta:
npx blockstudio init --yes
See loob vaikeseadetega faili blocks.json. Hiljem saad seda käsitsi muuta.
Ploki lisamine
npx blockstudio add ui/tabs
Vorming on namespace/block, kus namespace vastab võtmele sinu konfiguratsioonis registries.
CLI teeb järgmist:
- Hangib registri
- Leiab ploki
- Lahendab kõik sõltuvused (e.g.
tabssõltub üksusesttab-item) - Laadib alla kõik failid
- Kirjutab need sinu plokikataloogi
Kui plokk on ainult ühes registris, võid nimeruumi ära jätta:
npx blockstudio add tabs
Kui plokk on mitmes registris, palub CLI sul terminalis valida. Terminalita käivitamisel katkestatakse töö ning kuvatakse sobivate registrite loend; valik --yes kasutab blocks.json järjekorras esimest.
Mitme ploki lisamine
npx blockstudio add ui/tabs ui/hero ui/accordion
Kõik plokid installitakse ühe käivitamisega.
Eelvaade enne installimist
npx blockstudio add ui/tabs --dry-run
See näitab, mida installitaks, ilma ühtki faili kirjutamata.
Saadaolevate plokkide sirvimine
npx blockstudio list
npx blockstudio list ui
npx blockstudio search hero
list kuvab kõigi registrite plokid või ühe konkreetse registri plokid. search otsib tõstutundetult alamstringi alusel plokkide nimedest, pealkirjadest ja kirjeldustest.
Ploki eemaldamine
npx blockstudio remove tabs
See kustutab ploki kausta. Interaktiivses režiimis palutakse sul kustutamine kinnitada. Küsimuse vahelejätmiseks anna valik --yes.
CI ja automatiseerimine
init, add ja remove toetavad valikut --yes interaktiivsete küsimuste vahelejätmiseks. list ja search ei küsi kunagi midagi ning lükkavad tundmatu valikuna tagasi --yes. Kui stdin ei ole terminal (CI käivitajad või ümbersuunatud sisend), kasutab CLI mitteinteraktiivset režiimi: init kirjutab olemasoleva blocks.json üle, add katkestab veateatega, kui ploki kaust on juba olemas või ploki nimi on mitmetähenduslik, ning remove kustutab küsimata.
npx blockstudio init --yes --directory blockstudio
npx blockstudio add ui/tabs --yes
npx blockstudio remove tabs --yes