registry.json
registry.json är en JSON-fil som finns på en URL. Den listar alla tillgängliga block i ett register, deras metadata, beroenden och fillistor.
Schema
{
"$schema": "https://blockstudio.dev/schema/registry.json",
"name": "ui",
"description": "Core UI blocks for Blockstudio projects.",
"baseUrl": "https://raw.githubusercontent.com/acme/blocks/main/blocks",
"blocks": [
{
"name": "tabs",
"title": "Tabs",
"description": "Tabbed content with accessible keyboard navigation.",
"category": "layout",
"type": "blockstudio",
"dependencies": ["tab-item"],
"files": [
"block.json",
"index.php",
"style.scss"
]
}
]
}
Fält på toppnivå
name
Obligatoriskt. Registeridentifieraren. CLI validerar den men visar den inte: kommandon och utdata använder nyckeln som användaren valt för registret i blocks.json.
description
Valfritt. En kort beskrivning av vad registret innehåller.
baseUrl
Obligatoriskt. Bas-URL för hämtning av blockfiler. Måste vara en giltig URL.
Filer hämtas genom att kombinera bas-URL, blocknamnet och sökvägen till filen: {baseUrl}/{block.name}/{file}.
Om baseUrl till exempel är inställd på
https://raw.githubusercontent.com/acme/blocks/main/blocks och ett block heter
tabs med filen index.php hämtar CLI:
https://raw.githubusercontent.com/acme/blocks/main/blocks/tabs/index.php
Blockfält
name
Obligatoriskt. Blockets mappnamn. Det är identifieraren som används i kommandon för CLI och blir mappnamnet på disken.
title
Valfritt. Mänskligt läsbart namn som visas i utdata från list och search.
description
Valfritt. Enradig beskrivning som visas i resultaten från search.
category
Valfritt. Grupperingsetikett för utdata från list.
type
Valfritt. Ett av värdena blockstudio, create-block eller wordpress.
Det här är endast informativt. CLI ändrar inte beteendet utifrån blocktypen. Det hämtar och kopierar alltid filerna som anges i files.
dependencies
Valfritt. En lista med andra blocknamn i samma register som måste installeras tillsammans med det här blocket.
När en användare lägger till ett block med beroenden löser CLI hela beroendeträdet och installerar allt i rätt ordning. Cirkulära beroenden upptäcks och avvisas.
Beroenden måste finnas i samma register. Beroenden mellan register stöds inte.
files
Obligatoriskt. En lista med sökvägar till filer relativt blockmappen. Minst en fil krävs.
Det här är de exakta filer som CLI hämtar och skriver till disken. Sökvägarna kan innehålla undermappar:
{
"files": [
"block.json",
"index.php",
"style.scss",
"src/components/tabs.tsx",
"src/styles/tabs.css"
]
}
Sökvägsupplösning för filer
För varje fil i blockets manifest skapar CLI en hämtnings-URL:
{baseUrl}/{block.name}/{file}
Och skriver den till:
{directory}/{block.name}/{file}
Katalogstrukturen i blockmappen bevaras. Om en sökväg till en fil innehåller undermappar skapas de automatiskt.
Filer hämtas alltid från baseUrl i registry.json, inte från en plats relativ till register-URL i blocks.json.
Validering
CLI validerar registry.json mot ett Zod-schema vid varje hämtning.
Ogiltiga register ger tydliga felmeddelanden med de specifika fält som inte klarade valideringen.
Obligatoriska fält som saknas, tomma arrayer blocks eller files, ogiltiga URL:er och okända värden för type upptäcks alla innan några filer hämtas.