Skema blocks.json
Skema lengkap
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}"
}
}
}
}
Bidang
| Bidang | Tipe | Wajib | Deskripsi |
|---|---|---|---|
$schema |
string |
Tidak | JSON Schema URL untuk validasi editor. |
directory |
string |
Ya | Jalur relatif dari blocks.json tempat blok dipasang. Tidak boleh kosong. |
registries |
Record<string, string | RegistryRef> |
Ya | Pemetaan nama namespace ke referensi registri. Boleh kosong. |
Format referensi registri
Setiap nilai dalam registries berupa string URL atau objek:
String: URL yang valid ke file registry.json.
Objek:
| Bidang | Tipe | Wajib | Deskripsi |
|---|---|---|---|
url |
string |
Ya | URL yang valid ke file registry.json. |
headers |
Record<string, string> |
Tidak | Header HTTP yang dikirim bersama setiap permintaan ke registri ini. Nilainya mendukung interpolasi ${ENV_VAR}. |
Aturan validasi
directoryharus berupa string yang tidak kosong.- Setiap kunci dalam
registriesharus berupa string yang tidak kosong. - Nilai registri berupa string harus merupakan URL yang valid.
- Nilai registri berupa objek harus memiliki bidang
urlyang valid. - Referensi
${ENV_VAR}di header diselesaikan saat runtime. Variabel yang tidak ditemukan menghasilkan kesalahan yang menyebut nama variabel dan header. - Objek
registriesboleh kosong.addlalu keluar denganNo registries configured in blocks.json. Add a registry first.,listmencetakNo registries configured., dansearchmencetakNo blocks matching "<query>".
Penemuan konfigurasi
CLI mencari blocks.json mulai dari direktori kerja saat ini, lalu menelusuri direktori induk hingga 20 tingkat. blocks.json pertama yang ditemukan akan digunakan.