Pereiti prie turinio

blocks.json

blocks.json yra temos arba įskiepio šakniniame kataloge. Jis nurodo CLI, kur įdiegti blokus ir kuriuose registruose ieškoti.

Schema

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"
  }
}

Laukai

$schema

Neprivaloma. Nurodo JSON schemą, skirtą automatinio užbaigimo ir tikrinimo funkcijoms redaktoriuje.

directory

Privaloma. Santykinis kelias nuo blocks.json, kuriame įdiegiami blokai.

Kiekvienas blokas gauna poaplankį šiame kataloge. Jei directory yra blockstudio ir pridedate hero, failai įrašomi į blockstudio/hero/.

registries

Privaloma. Objektas, susiejantis vardų sričių pavadinimus su registrų nuorodomis.

Raktas yra vardų sritis, naudojama CLI komandose (npx blockstudio add ui/hero). Reikšmė yra URL eilutė arba objektas su url ir neprivalomu headers.

Eilutės formatas (viešieji registrai):

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

Objekto formatas (autentifikuoti registrai):

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

Abu formatai gali būti naudojami toje pačioje konfigūracijoje. Galite sukonfigūruoti kiek norite registrų. Pridėdama bloką nenurodžiusi vardų srities, CLI ieško visuose juose.

Autentifikavimas

Autentifikavimo reikalaujantys registrai naudoja objekto formatą su headers. CLI siunčia šias antraštes su kiekviena užklausa į tą registrą, įskaitant ir registry.json gavimą, ir atskirų failų atsisiuntimą.

„Bearer“ prieigos raktas

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

Bazinis autentifikavimas

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

Tinkintos antraštės

Galima pridėti bet kokią antraštę. Tai tinka API raktams, organizacijų identifikatoriams ar bet kokioms kitoms reikšmėms, kurių tikisi jūsų registro serveris:

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

Aplinkos kintamieji

Antraščių reikšmėse galima naudoti ${VAR_NAME} sintaksę aplinkos kintamiesiems nuskaityti. Taip prieigos raktai nepatenka į versijų valdymą.

CLI aplinkos kintamuosius nuskaito vykdymo metu. Jei nurodytas kintamasis nenustatytas, CLI pateikia klaidą, kurioje įvardijamas trūkstamas kintamasis ir antraštė, kurioje jis naudotas.

Nustatykite kintamąjį apvalkalo arba CI aplinkoje. CLI skaito tik proceso aplinką; pati programa failų .env neįkelia:

Shell
export REGISTRY_TOKEN=ghp_abc123
npx blockstudio add private/hero

Statinės antraščių reikšmės (be ${...}) perduodamos nepakeistos.

Konfigūracijos paieška

CLI nuo dabartinio darbinio katalogo kyla katalogų medžiu ir ieško blocks.json. Todėl komandas galite vykdyti iš bet kurio projekto pakatalogio.

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

Jei blocks.json nerandamas, CLI nurodo paleisti npx blockstudio init.

Pavyzdys: tema su dviem registrais

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"
  }
}

Pavyzdys: įskiepis su tinkintu katalogu

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