Pāriet uz saturu

Darba sākšana

Priekšnosacījumi

  • Node.js 18+
  • WordPress motīvs vai spraudnis, kurā vēlaties instalēt blokus

Pakotne blockstudio vietnē npm ir versijā 0.0.1. Šis laidiens ir vietturis: tajā ir tikai komanda add, kas izdrukā Adding block: <name> un beidzas, neko neiegūstot; tas arī noraida init, list, search, remove, --yes un --dry-run kā nezināmas komandas. Šajās lapās aprakstītās komandas attiecas uz reģistra CLI, kas atrodas repozitorijā Blockstudio (packages/registry).

Inicializējiet projektu

Palaidiet init sava motīva vai spraudņa saknes direktorijā:

Apvalks
npx blockstudio init

CLI palīdzēs veikt interaktīvo iestatīšanu:

  1. Bloku direktorija: kur instalēt blokus (noklusējums: blockstudio)
  2. Reģistri: pēc nosaukuma pievienojiet vienu vai vairākus reģistru URL

Tiek izveidots fails blocks.json:

JSON
{
  "$schema": "https://blockstudio.dev/schema/blocks.json",
  "directory": "blockstudio",
  "registries": {
    "ui": "https://blocks.example.com/registry.json"
  }
}

Varat arī izlaist interaktīvos jautājumus:

Apvalks
npx blockstudio init --yes

Tādējādi ar noklusējuma vērtībām tiek izveidots blocks.json. Pēc tam varat to rediģēt manuāli.

Pievienojiet bloku

Apvalks
npx blockstudio add ui/tabs

Formāts ir namespace/block, kur namespace atbilst atslēgai jūsu registries konfigurācijā.

Komanda CLI:

  1. Iegūst datus no reģistra
  2. Atrod bloku
  3. Atrisina atkarības (e.g. tabs ir atkarīgs no tab-item)
  4. Lejupielādē visus failus
  5. Ieraksta tos jūsu bloku direktorijā

Ja bloks ir tikai vienā reģistrā, nosaukumvietu var izlaist:

Apvalks
npx blockstudio add tabs

Ja tas ir vairākos reģistros, CLI terminālī lūdz izvēlēties. Ja termināļa nav, komanda tiek apturēta ar kļūdu, kurā uzskaitīti atbilstošie reģistri; ar --yes tiek izvēlēts pirmais atbilstošais reģistrs secībā blocks.json.

Pievienojiet vairākus blokus

Apvalks
npx blockstudio add ui/tabs ui/hero ui/accordion

Visi bloki tiek instalēti vienā izpildes reizē.

Priekšskatiet pirms instalēšanas

Apvalks
npx blockstudio add ui/tabs --dry-run

Tiek parādīts, kas tiktu instalēts, neierakstot nevienu failu.

Pārlūkojiet pieejamos blokus

Apvalks
npx blockstudio list
npx blockstudio list ui
npx blockstudio search hero

list parāda visus blokus no visiem reģistriem (vai konkrēta reģistra). search meklē bloku nosaukumos, virsrakstos un aprakstos teksta virkni, neņemot vērā burtu reģistru.

Noņemiet bloku

Apvalks
npx blockstudio remove tabs

Tiek dzēsta bloka mape. Interaktīvajā režīmā jums lūdz to apstiprināt. Norādiet --yes, lai izlaistu šo jautājumu.

CI un automatizācija

Komandas init, add un remove pieņem --yes, lai izlaistu interaktīvos jautājumus. list un search nekad neuzdod jautājumus un noraida --yes kā nezināmu opciju. Ja stdin nav terminālis (CI izpildītājos vai ievadot datus pa cauruli), CLI pāriet uz neinteraktīvo režīmu: init pārraksta esošu blocks.json, add aptur komandu ar kļūdu, ja bloka mape jau pastāv vai bloka nosaukums nav viennozīmīgs, un remove dzēš bez jautāšanas.

Apvalks
npx blockstudio init --yes --directory blockstudio
npx blockstudio add ui/tabs --yes
npx blockstudio remove tabs --yes