Aloitus
Edellytykset
- Node.js 18+
- WordPress-teema tai -lisäosa, johon haluat asentaa lohkoja
blockstudio-paketin versio 0.0.1 on osoitteessa npm. Kyseinen julkaisu on paikkamerkki: siinä on vain komento add, joka tulostaa Adding block: <name> ja poistuu hakematta mitään. Se hylkää tuntemattomina komennot init, list, search, remove, --yes ja --dry-run. Näiden sivujen komennot kuvaavat rekisterin CLI repositoriossa Blockstudio (packages/registry).
Alusta projektisi
Suorita init teemasi tai lisäosasi juuressa:
npx blockstudio init
CLI opastaa sinua vuorovaikutteisessa määrityksessä:
- Lohkohakemisto: hakemisto, johon lohkot asennetaan (oletus:
blockstudio) - Rekisterit: lisää yksi tai useampi rekisterin URL-osoite nimineen
Tämä luo tiedoston blocks.json:
{
"$schema": "https://blockstudio.dev/schema/blocks.json",
"directory": "blockstudio",
"registries": {
"ui": "https://blocks.example.com/registry.json"
}
}
Voit myös ohittaa vuorovaikutteiset kehotteet:
npx blockstudio init --yes
Tämä luo tiedoston blocks.json oletusarvoilla. Voit muokata sitä myöhemmin käsin.
Lisää lohko
npx blockstudio add ui/tabs
Muoto on namespace/block, jossa namespace vastaa asetuksessa registries olevaa avainta.
CLI:
- Noutaa rekisterin
- Etsii lohkon
- Ratkaisee riippuvuudet (e.g.
tabsriippuu lohkostatab-item) - Lataa kaikki tiedostot
- Kirjoittaa ne lohkohakemistoosi
Jos lohko löytyy vain yhdestä rekisteristä, voit jättää nimiavaruuden pois:
npx blockstudio add tabs
Jos lohko löytyy useasta rekisteristä, CLI pyytää valitsemaan päätteen kautta. Ilman päätettä se pysähtyy virheeseen, jossa luetellaan vastaavat rekisterit, ja --yes valitsee niistä ensimmäisen järjestyksessä blocks.json.
Lisää useita lohkoja
npx blockstudio add ui/tabs ui/hero ui/accordion
Kaikki lohkot asennetaan samalla suorituskerralla.
Esikatsele ennen asennusta
npx blockstudio add ui/tabs --dry-run
Tämä näyttää, mitä asennettaisiin, kirjoittamatta tiedostoja.
Selaa saatavilla olevia lohkoja
npx blockstudio list
npx blockstudio list ui
npx blockstudio search hero
list näyttää kaikkien rekisterien lohkot tai tietyn rekisterin lohkot. search hakee lohkojen nimistä, otsikoista ja kuvauksista kirjainkoosta riippumattomalla osamerkkijonohaulla.
Poista lohko
npx blockstudio remove tabs
Tämä poistaa lohkokansion. Vuorovaikutteisessa tilassa sinua pyydetään vahvistamaan poisto. Ohita kehote valitsimella --yes.
CI ja automaatio
init, add ja remove hyväksyvät valitsimen --yes vuorovaikutteisten kehotteiden ohittamiseen.
list ja search eivät koskaan näytä kehotteita ja hylkäävät valitsimen --yes tuntemattomana vaihtoehtona.
Kun stdin ei ole pääte (CI-ajot, putkisyöte), CLI siirtyy ei-vuorovaikutteiseen tilaan: init korvaa olemassa olevan blocks.json-tiedoston, add pysähtyy virheeseen, jos lohkokansio on jo olemassa tai lohkon nimi on epäselvä, ja remove poistaa kysymättä.
npx blockstudio init --yes --directory blockstudio
npx blockstudio add ui/tabs --yes
npx blockstudio remove tabs --yes