Värdhantera ett register
Ett register består av en registry.json-fil och en uppsättning blockmappar som tillhandahålls via
HTTP. Det krävs ingen särskild server. Allt som kan tillhandahålla statiska filer
fungerar.
Vad du behöver
- En
registry.json-fil som listar dina block - Blockmappar med filerna som manifestet hänvisar till
- En webbserver eller värdtjänst som tillhandahåller båda
Katalogstruktur
Ett typiskt registerkodförråd ser ut så här:
my-registry/
registry.json
blocks/
hero/
block.json
index.php
style.scss
tabs/
block.json
index.php
style.scss
tab-item/
block.json
index.php
registry.json pekar på katalogen blocks/ som sin baseUrl:
{
"name": "my-registry",
"baseUrl": "https://example.com/blocks",
"blocks": [
{
"name": "hero",
"title": "Hero",
"files": ["block.json", "index.php", "style.scss"]
}
]
}
Krav
Värdtjänsten måste stödja direkt filåtkomst via URL. CLI hämtar filer genom
att konstruera URL:er från {baseUrl}/{block.name}/{file}.
CLI har inget eget inloggningsflöde. För privata register hanterar du åtkomstkontrollen
på värdtjänstens sida (e.g. privata GitHub-kodförråd med token eller en
server som kontrollerar autentiseringsuppgifter) och låter konsumenterna skicka uppgifterna som
egna headers genom objektformatet i
blocks.json.
Testa registret
Innan du publicerar kan du testa lokalt genom att starta en enkel HTTP-server:
cd my-registry
npx serve .
Peka sedan blocks.json på http://localhost:3000/registry.json och
kör npx blockstudio list för att kontrollera att allt kan hittas. list hämtar bara
registry.json. Om du vill testa add anger du baseUrl till
http://localhost:3000/blocks under testningen, eftersom CLI laddar ner blockfiler
från baseUrl.