registry.json
registry.json er en JSON-fil, der hostes på en URL. Den indeholder en liste over alle blokke, der er tilgængelige i et register, samt deres metadata, afhængigheder og filmanifester.
Skema
{
"$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"
]
}
]
}
Felter på øverste niveau
name
Påkrævet. Registerets identifikator. CLI validerer den, men viser den ikke: kommandoer og output bruger den nøgle, som forbrugeren valgte til registeret i blocks.json.
description
Valgfrit. En kort beskrivelse af indholdet i dette register.
baseUrl
Påkrævet. Basis-URL til download af blokfiler. Skal være en gyldig URL.
Filer hentes ved at kombinere basis-URL, bloknavnet og filstien: {baseUrl}/{block.name}/{file}.
Hvis baseUrl for eksempel er sat til https://raw.githubusercontent.com/acme/blocks/main/blocks, og en blok med navnet tabs har filen index.php, henter CLI:
https://raw.githubusercontent.com/acme/blocks/main/blocks/tabs/index.php
Blokfelter
name
Påkrævet. Blokkens mappenavn. Dette er den identifikator, der bruges i CLI-kommandoer, og den bliver mappenavnet på disken.
title
Valgfrit. Et læsevenligt navn, der vises i output fra list og search.
description
Valgfrit. En beskrivelse på én linje, der vises i resultater fra search.
category
Valgfri grupperingsetiket for output fra list.
type
Valgfrit. En af blockstudio, create-block eller wordpress.
Dette er kun til orientering. CLI ændrer ikke adfærd ud fra blokkens type. Den downloader og kopierer altid de filer, der er angivet i files.
dependencies
Valgfrit. En liste over andre bloknavne i samme register, som skal installeres sammen med denne blok.
Når en bruger tilføjer en blok med afhængigheder, opløser CLI hele afhængighedstræet og installerer alt i den rigtige rækkefølge. Cirkulære afhængigheder registreres og afvises.
Afhængigheder skal findes i samme register. Afhængigheder på tværs af registre understøttes ikke.
files
Påkrævet. En liste over filstier, der er relative til blokmappen. Mindst én fil er påkrævet.
Dette er de præcise filer, som CLI downloader og skriver til disken. Stierne kan indeholde undermapper:
{
"files": [
"block.json",
"index.php",
"style.scss",
"src/components/tabs.tsx",
"src/styles/tabs.css"
]
}
Filopløsning
For hver fil i en blokmanifest konstruerer CLI en download-URL:
{baseUrl}/{block.name}/{file}
Og skriver den til:
{directory}/{block.name}/{file}
Mappestrukturen i blokmappen bevares. Hvis en filsti indeholder undermapper, oprettes de automatisk.
Filer hentes altid fra baseUrl i registry.json, ikke fra en placering, der er relativ til registerets URL i blocks.json.
Validering
CLI validerer registry.json mod et Zod-skema ved hver hentning.
Ugyldige registre giver tydelige fejlmeddelelser med angivelse af de felter, der ikke bestod valideringen.
Manglende obligatoriske felter, tomme blocks– eller files-lister, ugyldige URL’er og ukendte værdier for type fanges alle, før nogen filer downloades.