Liigu sisu juurde

blocks.json

blocks.json asub sinu teema või plugina juurkataloogis. See ütleb CLI-le, kuhu plokid installida ja millistest registritest otsida.

Skeem

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

Väljad

$schema

Valikuline. Viitab JSON skeemile redaktori automaattäitmise ja valideerimise jaoks.

directory

Kohustuslik. Suhteline tee asukohast blocks.json, kuhu plokid installitakse.

Iga plokk saab selles kataloogis oma alamkausta. Kui directory on blockstudio ja lisad hero, salvestatakse failid asukohta blockstudio/hero/.

registries

Kohustuslik. Objekt, mis seostab nimeruumide nimed registriviidetega.

Võti on nimeruum, mida kasutatakse CLI käskudes (npx blockstudio add ui/hero). Väärtus on kas URL tüüpi string või objekt väljadega url ja valikulise väljaga headers.

Stringvorming (avalikud registrid):

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

Objektivorming (autenditud registrid):

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

Mõlemat vormingut saab kasutada samas konfiguratsioonis. Seadistada võib nii palju registreid kui soovid. Kui lisad ploki ilma nimeruumita, otsib CLI neist kõigist.

Autentimine

Autentimist nõudvate registrite puhul kasutatakse objektivormingut väljaga headers. CLI saadab need päised igas registrile tehtavas päringus, nii registry.json hankimisel kui ka üksikute failide allalaadimisel.

Beareri tunnus

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

Lihtautentimine

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

Kohandatud päised

Lisada saab mis tahes päise. See sobib API võtmete, organisatsiooni identifikaatorite või muude väärtuste jaoks, mida sinu registriserver ootab:

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

Keskkonnamuutujad

Päiseväärtustes saab kasutada süntaksit ${VAR_NAME} keskkonnamuutujate lugemiseks. Nii jäävad tunnused versioonihaldusest välja.

CLI lahendab keskkonnamuutujad käitusajal. Kui viidatud muutuja pole määratud, väljub CLI veateatega, mis nimetab puuduva muutuja ja päise, milles seda kasutati.

Määra muutuja oma käsureas või CI keskkonnas. CLI loeb ainult protsessi keskkonda; see ei laadi .env faile ise:

Shell
export REGISTRY_TOKEN=ghp_abc123
npx blockstudio add private/hero

Staatilised päiseväärtused (ilma ${...}-ta) edastatakse muutmata kujul.

Konfiguratsiooni leidmine

CLI liigub praegusest töökataloogist ülespoole ja otsib faili blocks.json. Nii saad käske käivitada projekti mis tahes alamkataloogist.

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

Kui faili blocks.json ei leita, palub CLI käivitada käsu npx blockstudio init.

Näide: kahe registriga teema

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

Näide: kohandatud kataloogiga plugin

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