Pereiti prie turinio

Darbo pradžia

Būtinosios sąlygos

  • Node.js 18+
  • WordPress tema arba įskiepis, kuriame norite įdiegti blokus

blockstudio paketo versija npm yra 0.0.1. Tai tarpinė laida: joje yra tik add komanda, kuri išveda Adding block: <name> ir baigia darbą nieko neatsisiuntusi, o init, list, search, remove, --yes ir --dry-run komandas atmeta kaip nežinomas. Šiuose puslapiuose aprašomos registro CLI komandos, esančios saugykloje Blockstudio (packages/registry).

Projekto inicijavimas

Temos arba įskiepio šakniniame kataloge paleiskite init:

Shell
npx blockstudio init

CLI padės atlikti interaktyvią sąranką:

  1. Blokų katalogas: kur įdiegti blokus (numatyta: blockstudio)
  2. Registrai: pridėkite vieną ar daugiau registrų URL ir priskirkite jiems pavadinimus

Taip sukuriamas failas blocks.json:

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

Taip pat galite praleisti interaktyvius klausimus:

Shell
npx blockstudio init --yes

Taip sukuriamas blocks.json su numatytosiomis reikšmėmis. Vėliau galite jį redaguoti rankiniu būdu.

Bloko pridėjimas

Shell
npx blockstudio add ui/tabs

Formatas yra namespace/block, kur namespace atitinka jūsų konfigūracijos faile registries esantį raktą.

CLI:

  1. Gauna registrą
  2. Randa bloką
  3. Išsprendžia visas priklausomybes (e.g. tabs priklauso nuo tab-item)
  4. Atsisiunčia visus failus
  5. Įrašo juos į jūsų bloko katalogą

Jei blokas yra tik viename registre, vardų srities nurodyti nereikia:

Shell
npx blockstudio add tabs

Jei blokas yra keliuose registruose, CLI terminale paprašo pasirinkti. Jei terminalo nėra, komanda sustoja ir pateikia atitinkančių registrų sąrašą, o --yes pasirenka pirmą registrą pagal blocks.json tvarką.

Kelių blokų pridėjimas

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

Visi blokai įdiegiami per vieną vykdymą.

Peržiūra prieš diegimą

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

Parodoma, kas būtų įdiegta, neįrašant jokių failų.

Prieinamų blokų peržiūra

Shell
npx blockstudio list
npx blockstudio list ui
npx blockstudio search hero

list pateikia visus blokų registrus arba nurodytą registrą. Naudojant search ieškoma pagal didžiųjų ir mažųjų raidžių neskiriantį dalinį sutapimą blokų pavadinimuose, antraštėse ir aprašuose.

Bloko šalinimas

Shell
npx blockstudio remove tabs

Taip ištrinamas bloko aplankas. Interaktyviuoju režimu jūsų prašoma patvirtinti. Norėdami praleisti klausimą, naudokite --yes.

CI ir automatizavimas

init, add ir remove priima --yes, kuri praleidžia interaktyvius klausimus. list ir search niekada neklausia ir atmeta --yes kaip nežinomą parinktį. Kai standartinė įvestis nėra terminalas (CI vykdyklėse ar perduodant įvestį per srautą), CLI pereina į neinteraktyvųjį režimą: init perrašo esamą blocks.json, add sustabdo komandą su klaida, jei bloko aplankas jau yra arba bloko pavadinimas dviprasmiškas, o remove ištrina neklausdamas.

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