registry.json
registry.json ir JSON fails, kas mitināts URL. Tajā uzskaitīti visi reģistrā pieejamie bloki, to metadati, atkarības un failu manifesti.
Shēma
{
"$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"
]
}
]
}
Augšējā līmeņa lauki
name
Obligāts. Reģistra identifikators. CLI to validē, bet nerāda: komandas un izvade izmanto atslēgu, ko patērētājs izvēlējies reģistram blocks.json.
description
Neobligāts. Īss apraksts par šī reģistra saturu.
baseUrl
Obligāts. Pamat-URL bloku failu lejupielādei. Jābūt derīgam URL.
Faili tiek iegūti, apvienojot pamat-URL, bloka nosaukumu un faila ceļu: {baseUrl}/{block.name}/{file}.
Piemēram, ja baseUrl ir iestatīts uz
https://raw.githubusercontent.com/acme/blocks/main/blocks un bloks ar nosaukumu tabs satur failu index.php, CLI iegūst:
https://raw.githubusercontent.com/acme/blocks/main/blocks/tabs/index.php
Bloka lauki
name
Obligāts. Bloka mapes nosaukums. Šo identifikatoru izmanto CLI komandās, un tas kļūst par mapes nosaukumu diskā.
title
Neobligāts. Cilvēkam saprotams nosaukums, kas redzams list un search izvadē.
description
Neobligāts. Vienas rindas apraksts, kas redzams search rezultātos.
category
Neobligāta grupas etiķete izvadē list.
type
Neobligāts. Viena no vērtībām blockstudio, create-block vai wordpress.
Šis lauks ir tikai informatīvs. CLI nemaina darbību atkarībā no bloka tipa. Tas vienmēr lejupielādē un kopē failus, kas norādīti sadaļā files.
dependencies
Neobligāts. Citu bloku nosaukumu masīvs no tā paša reģistra, kas jāinstalē kopā ar šo bloku.
Kad lietotājs pievieno bloku ar atkarībām, CLI atrisina visu atkarību koku un instalē visu pareizajā secībā. Cikliskas atkarības tiek konstatētas un noraidītas.
Atkarībām jābūt tajā pašā reģistrā. Atkarības starp reģistriem netiek atbalstītas.
files
Obligāts. Failu ceļu masīvs, kas norādīts attiecībā pret bloka mapi. Nepieciešams vismaz viens fails.
Šie ir precīzi faili, ko CLI lejupielādē un ieraksta diskā. Ceļos var būt apakšdirektorijas:
{
"files": [
"block.json",
"index.php",
"style.scss",
"src/components/tabs.tsx",
"src/styles/tabs.css"
]
}
Failu atrašana
Katram failam bloka manifestā CLI izveido lejupielādes URL:
{baseUrl}/{block.name}/{file}
Un ieraksta to šeit:
{directory}/{block.name}/{file}
Bloka mapes iekšējā direktoriju struktūra tiek saglabāta. Ja faila ceļā ir apakšdirektorijas, tās tiek izveidotas automātiski.
Faili vienmēr tiek iegūti no baseUrl, kas norādīts registry.json, nevis no atrašanās vietas, kas ir relatīva pret reģistra URL sadaļā blocks.json.
Validācija
CLI katras izgūšanas reizē validē registry.json pēc Zod shēmas.
Nederīgi reģistri izraisa skaidrus kļūdu paziņojumus ar konkrētiem laukiem, kuru validācija neizdevās.
Trūkstoši obligātie lauki, tukšas blocks vai files virknes, nederīgi URL un nezināmas type vērtības tiek konstatētas pirms failu lejupielādes.