Esquema registry.json
Esquema completo
JSON
{
"$schema": "https://blockstudio.dev/schema/registry.json",
"name": "my-registry",
"description": "A collection of WordPress blocks.",
"baseUrl": "https://example.com/blocks",
"blocks": [
{
"name": "hero",
"title": "Hero",
"description": "Full-width hero section with heading and CTA.",
"category": "layout",
"type": "blockstudio",
"dependencies": ["button"],
"files": [
"block.json",
"index.php",
"style.scss"
]
}
]
}
Campos de nível superior
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
$schema |
string |
Não | Schema JSON URL para validação no editor. |
name |
string |
Sim | Identificador do registro. Não pode estar vazio. |
description |
string |
Não | Descrição breve do registro. |
baseUrl |
string |
Sim | URL base para baixar arquivos de blocos. Deve ser um URL válido. |
blocks |
BlockEntry[] |
Sim | Lista de blocos disponíveis. Deve conter pelo menos uma entrada. |
Campos de entrada do bloco
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name |
string |
Sim | Nome da pasta do bloco e identificador CLI. Não pode estar vazio. |
title |
string |
Não | Nome de exibição legível. |
description |
string |
Não | Descrição de uma linha para os resultados da pesquisa. |
category |
string |
Não | Rótulo de agrupamento para a saída da lista. |
type |
"blockstudio" | "create-block" | "wordpress" |
Não | Tipo de bloco. Apenas informativo; não afeta o comportamento de CLI. |
dependencies |
string[] |
Não | Nomes de blocos no mesmo registro que precisam ser instalados junto com este bloco. |
files |
string[] |
Sim | Caminhos de arquivos relativos à pasta do bloco. É necessário pelo menos um arquivo. |
Resolução de arquivos
Cada arquivo é baixado de:
Código
{baseUrl}/{block.name}/{file}
E gravado em:
Código
{directory}/{block.name}/{file}
Os subdiretórios nos caminhos dos arquivos são criados automaticamente.
Regras de validação
namenão pode estar vazio nos níveis do registro e do bloco.baseUrlprecisa ser um URL válido.blocksprecisa conter pelo menos uma entrada.filesde cada bloco precisa conter pelo menos uma entrada.- Se
typefor fornecido, precisa ser um dos três valores permitidos. - Se
dependenciesfor fornecido, precisa ser uma lista de strings. Cada dependência precisa existir no mesmo registro; caso contrário, o CLI apresentará um erro ao resolver.