Μετάβαση στο περιεχόμενο

Σχήμα blocks.json

Πλήρες σχήμα

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

Πεδία

Πεδίο Τύπος Υποχρεωτικό Περιγραφή
$schema string Όχι Σχήμα JSON URL για επικύρωση στον επεξεργαστή.
directory string Ναι Σχετική διαδρομή από το blocks.json όπου εγκαθίστανται τα block. Δεν μπορεί να είναι κενή.
registries Record<string, string | RegistryRef> Ναι Αντιστοίχιση ονομάτων namespace σε αναφορές μητρώων. Μπορεί να είναι κενή.

Μορφές αναφοράς μητρώου

Κάθε τιμή στο registries είναι είτε συμβολοσειρά URL είτε αντικείμενο:

Συμβολοσειρά: έγκυρο URL προς αρχείο registry.json.

Αντικείμενο:

Πεδίο Τύπος Υποχρεωτικό Περιγραφή
url string Ναι Έγκυρο URL προς αρχείο registry.json.
headers Record<string, string> Όχι Κεφαλίδες HTTP που αποστέλλονται με κάθε αίτημα σε αυτό το μητρώο. Οι τιμές υποστηρίζουν παρεμβολή ${ENV_VAR}.

Κανόνες επικύρωσης

  • Το directory πρέπει να είναι μη κενή συμβολοσειρά.
  • Κάθε κλειδί στο registries πρέπει να είναι μη κενή συμβολοσειρά.
  • Οι τιμές μητρώου τύπου συμβολοσειράς πρέπει να είναι έγκυρα URL.
  • Οι τιμές μητρώου τύπου αντικειμένου πρέπει να έχουν έγκυρο πεδίο url.
  • Οι αναφορές ${ENV_VAR} στις κεφαλίδες επιλύονται κατά τον χρόνο εκτέλεσης. Αν λείπει κάποια μεταβλητή, εμφανίζεται σφάλμα που κατονομάζει τη μεταβλητή και την κεφαλίδα.
  • Το αντικείμενο registries μπορεί να είναι κενό. Τότε το add τερματίζει με No registries configured in blocks.json. Add a registry first., το list εμφανίζει No registries configured. και το search εμφανίζει No blocks matching "<query>".

Εντοπισμός ρυθμίσεων

Το CLI αναζητά το blocks.json ξεκινώντας από τον τρέχοντα κατάλογο εργασίας και ανεβαίνοντας στους γονικούς καταλόγους έως και 20 επίπεδα. Χρησιμοποιείται το πρώτο blocks.json που εντοπίζεται.