Pāriet uz saturu

blocks.json

blocks.json atrodas jūsu motīva vai spraudņa saknes direktorijā. Tas norāda CLI, kur instalēt blokus un kuros reģistros meklēt.

Shēma

JSON
{
  "$schema": "https://blockstudio.dev/schema/blocks.json",
  "directory": "blockstudio",
  "registries": {
    "ui": "https://blocks.example.com/registry.json",
    "starter": "https://raw.githubusercontent.com/acme/blocks/main/registry.json"
  }
}

Lauki

$schema

Neobligāts. Norāda uz JSON shēmu redaktora automātiskajai pabeigšanai un validācijai.

directory

Obligāts. Relatīvais ceļš no blocks.json, kurā tiek instalēti bloki.

Katram blokam šajā direktorijā tiek izveidota sava apakšmape. Ja directory ir blockstudio un pievienojat hero, faili tiek ievietoti mapē blockstudio/hero/.

registries

Obligāts. Objekts, kas sasaista nosaukumvietu nosaukumus ar reģistru atsaucēm.

Atslēga ir nosaukumvieta, ko izmanto CLI komandās (npx blockstudio add ui/hero). Vērtība ir vai nu URL virkne, vai objekts ar url un neobligātu headers.

Virknes formāts (publiski reģistri):

JSON
{
  "registries": {
    "ui": "https://example.com/registry.json"
  }
}

Objekta formāts (reģistri ar autentifikāciju):

JSON
{
  "registries": {
    "private": {
      "url": "https://private.example.com/registry.json",
      "headers": {
        "Authorization": "Bearer ${REGISTRY_TOKEN}"
      }
    }
  }
}

Abus formātus var izmantot vienā konfigurācijas failā. Varat konfigurēt neierobežotu skaitu reģistru. Pievienojot bloku bez nosaukumvietas, CLI meklē visos reģistros.

Autentifikācija

Reģistros, kam nepieciešama autentifikācija, jāizmanto objekta formāts ar headers. CLI katrā pieprasījumā šim reģistram nosūta šīs galvenes, tostarp gan registry.json izgūšanas pieprasījumā, gan atsevišķu failu lejupielādēs.

Bearer pilnvara

JSON
{
  "registries": {
    "private": {
      "url": "https://api.example.com/registry.json",
      "headers": {
        "Authorization": "Bearer ${REGISTRY_TOKEN}"
      }
    }
  }
}

Pamata autentifikācija

JSON
{
  "registries": {
    "private": {
      "url": "https://api.example.com/registry.json",
      "headers": {
        "Authorization": "Basic ${REGISTRY_CREDENTIALS}"
      }
    }
  }
}

Pielāgotas galvenes

Var pievienot jebkuru galveni. Tas noder API atslēgām, organizācijas identifikatoriem un citām vērtībām, ko pieprasa jūsu reģistra serveris:

JSON
{
  "registries": {
    "internal": {
      "url": "https://blocks.internal.company.com/registry.json",
      "headers": {
        "X-API-Key": "${BLOCKS_API_KEY}",
        "X-Org-ID": "acme"
      }
    }
  }
}

Vides mainīgie

Galveņu vērtībās var izmantot sintaksi ${VAR_NAME}, lai nolasītu vides mainīgos. Tādējādi pilnvaras nav jāiekļauj versiju kontrolē.

CLI izpildes laikā nolasa vides mainīgos. Ja norādītais mainīgais nav iestatīts, CLI beidzas ar kļūdu, kurā norādīts trūkstošais mainīgais un galvene, kurā tas tika izmantots.

Iestatiet mainīgo čaulā vai CI vidē. CLI nolasa tikai procesa vidi; tas pats par sevi nenolasa .env failus:

Apvalks
export REGISTRY_TOKEN=ghp_abc123
npx blockstudio add private/hero

Statiskās galveņu vērtības (bez ${...}) tiek padotas tālāk bez izmaiņām.

Konfigurācijas atrašana

CLI, sākot no pašreizējā darba direktorija, virzās augšup pa direktoriju struktūru, meklējot blocks.json. Tāpēc komandas varat palaist no jebkuras projekta apakšdirektorijas.

Kods
my-theme/
  blocks.json        <- found here
  blockstudio/
    hero/
  templates/
    page.php          <- running `npx blockstudio add` here still works

Ja blocks.json nav atrasts, CLI norāda palaist npx blockstudio init.

Piemērs: motīvs ar diviem reģistriem

JSON
{
  "$schema": "https://blockstudio.dev/schema/blocks.json",
  "directory": "blockstudio",
  "registries": {
    "ui": "https://blocks.mycompany.com/ui/registry.json",
    "internal": "https://blocks.mycompany.com/internal/registry.json"
  }
}

Piemērs: spraudnis ar pielāgotu direktoriju

JSON
{
  "$schema": "https://blockstudio.dev/schema/blocks.json",
  "directory": "src/blocks",
  "registries": {
    "starter": "https://raw.githubusercontent.com/acme/blocks/main/registry.json"
  }
}