Ga naar de inhoud

Aan de slag

Vereisten

  • Node.js 18+
  • Een WordPress-thema of plug-in waarin je blokken wilt installeren

Het blockstudio-pakket op npm heeft versie 0.0.1. Die versie is een tijdelijke aanduiding: deze bevat alleen een opdracht add, die Adding block: <name> toont en afsluit zonder iets op te halen, en wijst init, list, search, remove, --yes en --dry-run af als onbekend. De opdrachten op deze pagina’s beschrijven het register-CLI in de Blockstudio-repository (packages/registry).

Je project initialiseren

Voer init uit in de hoofdmap van je thema of plug-in:

Shell
npx blockstudio init

De CLI begeleidt je bij een interactieve configuratie:

  1. Blokmap: waar blokken moeten worden geïnstalleerd (standaard: blockstudio)
  2. Registers: voeg een of meer register-URL’s toe op naam

Dit maakt een bestand blocks.json aan:

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

Je kunt de interactieve vragen ook overslaan:

Shell
npx blockstudio init --yes

Dit maakt een blocks.json met standaardwaarden aan. Je kunt het daarna handmatig bewerken.

Een blok toevoegen

Shell
npx blockstudio add ui/tabs

Het formaat is namespace/block, waarbij namespace overeenkomt met een sleutel in je registries-configuratie.

De CLI:

  1. Haalt het register op
  2. Zoekt het blok
  3. Zoekt eventuele afhankelijkheden op (e.g. tabs is afhankelijk van tab-item)
  4. Downloadt alle bestanden
  5. Schrijft ze naar je blokmap

Als het blok in slechts één register staat, kun je de naamruimte weglaten:

Shell
npx blockstudio add tabs

Als het blok in meerdere registers staat, vraagt de CLI je in de terminal om een keuze te maken. Zonder terminal stopt deze met een foutmelding waarin de overeenkomende registers worden vermeld; met --yes wordt het eerste register in de volgorde van blocks.json gebruikt.

Meerdere blokken toevoegen

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

Alle blokken worden in één uitvoering geïnstalleerd.

Voorbeeld bekijken vóór installatie

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

Hiermee zie je wat er geïnstalleerd zou worden, zonder bestanden te schrijven.

Beschikbare blokken bekijken

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

list toont alle blokken uit alle registers (of uit één specifiek register). search zoekt hoofdletterongevoelig naar zoektermen als deelreeks in bloknamen, titels en beschrijvingen.

Een blok verwijderen

Shell
npx blockstudio remove tabs

Hiermee verwijder je de blokmap. In interactieve modus wordt je om bevestiging gevraagd. Geef --yes op om de vraag over te slaan.

CI en automatisering

init, add en remove accepteren --yes om interactieve vragen over te slaan. list en search stellen nooit vragen en wijzen --yes af als onbekende optie. Wanneer stdin geen terminal is (bijvoorbeeld bij CI-runners of gepipete invoer), schakelt de CLI over naar niet-interactieve modus: init overschrijft een bestaande blocks.json, add stopt met een foutmelding als een blokmap al bestaat of een bloknaam ambigu is, en remove verwijdert zonder te vragen.

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