Kom igång
Förutsättningar
- Node.js 18+
- Ett tema eller tillägg för WordPress där du vill installera block
Paketet blockstudio på npm är i version 0.0.1. Den versionen är en platshållare: den har bara ett kommando för add, som skriver ut Adding block: <name> och avslutas utan att hämta något, och den avvisar init, list, search, remove, --yes och --dry-run som okända. Kommandona på dessa sidor beskriver registret CLI i kodförrådet Blockstudio (packages/registry).
Initiera projektet
Kör init i roten av ditt tema eller tillägg:
npx blockstudio init
CLI vägleder dig genom en interaktiv konfiguration:
- Blockkatalog: var block ska installeras (standard:
blockstudio) - Register: lägg till en eller flera register-URL:er med namn
Detta skapar en blocks.json-fil:
{
"$schema": "https://blockstudio.dev/schema/blocks.json",
"directory": "blockstudio",
"registries": {
"ui": "https://blocks.example.com/registry.json"
}
}
Du kan också hoppa över de interaktiva frågorna:
npx blockstudio init --yes
Detta skapar en blocks.json med standardvärden. Du kan redigera den manuellt efteråt.
Lägg till ett block
npx blockstudio add ui/tabs
Formatet är namespace/block, där namespace matchar en nyckel i din registries-konfiguration.
CLI:
- Hämtar registret
- Hittar blocket
- Löser eventuella beroenden (e.g.
tabsär beroende avtab-item) - Hämtar alla filer
- Skriver dem till blockkatalogen
Om blocket bara finns i ett register kan du utelämna namnrymden:
npx blockstudio add tabs
Om det finns i flera register ber CLI dig välja i en terminal. Utan en terminal avbryts det med ett felmeddelande som listar matchande register, och --yes väljer det första i ordningen blocks.json.
Lägg till flera block
npx blockstudio add ui/tabs ui/hero ui/accordion
Alla block installeras i en enda körning.
Förhandsvisa före installation
npx blockstudio add ui/tabs --dry-run
Detta visar vad som skulle installeras utan att skriva några filer.
Bläddra bland tillgängliga block
npx blockstudio list
npx blockstudio list ui
npx blockstudio search hero
list visar alla block från alla register (eller ett specifikt register). search söker efter delsträngar i blocknamn, titlar och beskrivningar utan att skilja på stora och små bokstäver.
Ta bort ett block
npx blockstudio remove tabs
Detta tar bort blockmappen. I interaktivt läge ombeds du bekräfta. Ange --yes för att hoppa över frågan.
CI och automatisering
init, add och remove accepterar --yes för att hoppa över interaktiva frågor.
list och search ställer aldrig frågor och avvisar --yes som ett okänt alternativ.
När stdin inte är en terminal (CI-körningar, rörkopplad indata) växlar CLI till icke-interaktivt läge: init skriver över en befintlig blocks.json, add avbryts med ett fel om en blockmapp redan finns eller ett blocknamn är tvetydigt, och remove tar bort utan att fråga.
npx blockstudio init --yes --directory blockstudio
npx blockstudio add ui/tabs --yes
npx blockstudio remove tabs --yes