Treci la conținut

Primii pași

Cerințe preliminare

  • Node.js 18+
  • O temă sau un modul WordPress în care doriți să instalați blocuri

Pachetul blockstudio de pe npm este la versiunea 0.0.1. Această versiune este un substituent: are doar o comandă add, care afișează Adding block: <name> și se încheie fără să preia nimic, și respinge init, list, search, remove, --yes și --dry-run ca necunoscute. Comenzile de pe aceste pagini descriu registrul CLI din depozitul Blockstudio (packages/registry).

Inițializați proiectul

Rulați init în directorul rădăcină al temei sau modulului dvs.:

Shell
npx blockstudio init

CLI vă ghidează printr-o configurare interactivă:

  1. Directorul blocurilor: unde trebuie instalate blocurile (implicit: blockstudio)
  2. Registre: adăugați unul sau mai multe URL-uri de registre, folosind nume

Aceasta creează un fișier blocks.json:

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

Puteți omite și solicitările interactive:

Shell
npx blockstudio init --yes

Aceasta creează un fișier blocks.json cu valorile implicite. Îl puteți edita manual ulterior.

Adăugați un bloc

Shell
npx blockstudio add ui/tabs

Formatul este namespace/block, unde namespace corespunde unei chei din configurația dvs. registries.

CLI:

  1. Preia registrul
  2. Găsește blocul
  3. Rezolvă eventualele dependențe (e.g. tabs depinde de tab-item)
  4. Descarcă toate fișierele
  5. Le scrie în directorul blocurilor dvs.

Dacă blocul există într-un singur registru, puteți omite spațiul de nume:

Shell
npx blockstudio add tabs

Dacă există în mai multe registre, CLI vă solicită să alegeți într-un terminal. Fără terminal, se oprește cu o eroare care enumeră registrele corespunzătoare, iar --yes îl alege pe primul, în ordinea blocks.json.

Adăugați mai multe blocuri

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

Toate blocurile sunt instalate într-o singură rulare.

Previzualizați înainte de instalare

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

Afișează ce s-ar instala fără să scrie vreun fișier.

Răsfoiți blocurile disponibile

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

list afișează toate blocurile din toate registrele (sau dintr-un anumit registru). search caută potriviri de subșiruri, fără a ține cont de majuscule, în numele, titlurile și descrierile blocurilor.

Eliminați un bloc

Shell
npx blockstudio remove tabs

Aceasta șterge directorul blocului. În modul interactiv, vi se solicită confirmarea. Transmiteți --yes pentru a omite solicitarea.

CI și automatizare

init, add și remove acceptă --yes pentru a omite solicitările interactive. list și search nu afișează niciodată solicitări și resping --yes ca opțiune necunoscută. Când stdin nu este un terminal (executanți CI, intrare redirecționată), CLI trece la modul non-interactiv: init suprascrie un blocks.json existent, add se oprește cu o eroare dacă directorul blocului există deja sau numele blocului este ambiguu, iar remove șterge fără confirmare.

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