Pular para o conteúdo

Esquema blocks.json

Esquema completo

JSON
{
  "$schema": "https://blockstudio.dev/schema/blocks.json",
  "directory": "blockstudio",
  "registries": {
    "public": "https://example.com/registry.json",
    "private": {
      "url": "https://private.example.com/registry.json",
      "headers": {
        "Authorization": "Bearer ${REGISTRY_TOKEN}"
      }
    }
  }
}

Campos

Campo Tipo Obrigatório Descrição
$schema string Não Schema JSON URL para validação no editor.
directory string Sim Caminho relativo de blocks.json onde os blocos são instalados. Não pode estar vazio.
registries Record<string, string | RegistryRef> Sim Mapeamento de nomes de namespace para referências de registros. Pode estar vazio.

Formatos de referência de registro

Cada valor em registries é uma string URL ou um objeto:

String: um URL válido para um arquivo registry.json.

Objeto:

Campo Tipo Obrigatório Descrição
url string Sim URL válido para um arquivo registry.json.
headers Record<string, string> Não Cabeçalhos HTTP enviados com cada requisição a este registro. Os valores aceitam interpolação ${ENV_VAR}.

Regras de validação

  • directory precisa ser uma string não vazia.
  • Cada chave em registries precisa ser uma string não vazia.
  • Os valores de registro em formato de string precisam ser URLs válidas.
  • Os valores de registro em formato de objeto precisam ter um campo url válido.
  • As referências ${ENV_VAR} nos cabeçalhos são resolvidas em tempo de execução. Variáveis ausentes geram um erro que identifica a variável e o cabeçalho.
  • O objeto registries pode estar vazio. Nesse caso, add encerra com No registries configured in blocks.json. Add a registry first., list exibe No registries configured. e search exibe No blocks matching "<query>".

Localização da configuração

O CLI procura blocks.json a partir do diretório de trabalho atual, subindo pelos diretórios pais por até 20 níveis. O primeiro blocks.json encontrado é usado.