Gå til indhold

Kom godt i gang

Forudsætninger

  • Node.js 18+
  • Et WordPress-tema eller plugin, hvor du vil installere blokke

Pakken blockstudio på npm har version 0.0.1. Denne udgivelse er en pladsholder: den har kun en add-kommando, som udskriver Adding block: <name> og afslutter uden at hente noget, og den afviser init, list, search, remove, --yes og --dry-run som ukendte. Kommandoerne på disse sider beskriver register-CLI i Blockstudio-lageret (packages/registry).

Initialisér dit projekt

Kør init i roden af dit tema eller plugin:

Shell
npx blockstudio init

CLI guider dig gennem en interaktiv opsætning:

  1. Blokmappe: hvor blokke skal installeres (standard: blockstudio)
  2. Registre: tilføj en eller flere register-URL’er med navn

Dette opretter en fil med blocks.json:

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

Du kan også springe de interaktive spørgsmål over:

Shell
npx blockstudio init --yes

Dette opretter en blocks.json med standardværdier. Du kan redigere den manuelt bagefter.

Tilføj en blok

Shell
npx blockstudio add ui/tabs

Formatet er namespace/block, hvor namespace svarer til en nøgle i din registries-konfiguration.

CLI:

  1. Henter registeret
  2. Finder blokken
  3. Opløser eventuelle afhængigheder (e.g. tabs afhænger af tab-item)
  4. Downloader alle filer
  5. Skriver dem til din blokmappe

Hvis blokken kun findes i ét register, kan du udelade navneområdet:

Shell
npx blockstudio add tabs

Hvis den findes i flere registre, beder CLI dig om at vælge i en terminal. Uden en terminal stopper den med en fejl, der viser de matchende registre, og --yes vælger det første i rækkefølgen blocks.json.

Tilføj flere blokke

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

Alle blokke installeres i én kørsel.

Forhåndsvis før installation

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

Dette viser, hvad der ville blive installeret, uden at skrive nogen filer.

Gennemse tilgængelige blokke

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

list viser alle blokke fra alle registre (eller fra et bestemt register). search søger efter delstrenge i bloknavne, titler og beskrivelser uden forskel på store og små bogstaver.

Fjern en blok

Shell
npx blockstudio remove tabs

Dette sletter blokmappen. I interaktiv tilstand bliver du bedt om at bekræfte. Angiv --yes for at springe spørgsmålet over.

CI og automatisering

init, add og remove accepterer --yes for at springe interaktive spørgsmål over. list og search viser aldrig spørgsmål og afviser --yes som et ukendt tilvalg. Når stdin ikke er en terminal (CI-kørsler, pipet input), skifter CLI til ikke-interaktiv tilstand: init overskriver en eksisterende blocks.json, add stopper med en fejl, når en blokmappe allerede findes, eller et bloknavn er tvetydigt, og remove sletter uden at spørge.

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