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

Φιλοξενία μητρώου

Ένα μητρώο είναι ένα αρχείο registry.json και ένα σύνολο φακέλων block που διατίθενται μέσω HTTP. Δεν απαιτείται ειδικός διακομιστής. Αρκεί οτιδήποτε μπορεί να διαθέσει στατικά αρχεία.

Τι χρειάζεστε

  1. Ένα αρχείο registry.json που παραθέτει τα block σας
  2. Φακέλους block με τα αρχεία που αναφέρονται στο manifest
  3. Έναν διακομιστή ιστού ή υπηρεσία φιλοξενίας που διαθέτει και τα δύο

Δομή καταλόγων

Ένα τυπικό αποθετήριο μητρώου έχει την εξής μορφή:

Κώδικας
my-registry/
  registry.json
  blocks/
    hero/
      block.json
      index.php
      style.scss
    tabs/
      block.json
      index.php
      style.scss
    tab-item/
      block.json
      index.php

Το registry.json δείχνει στον κατάλογο blocks/ ως το baseUrl του:

JSON
{
  "name": "my-registry",
  "baseUrl": "https://example.com/blocks",
  "blocks": [
    {
      "name": "hero",
      "title": "Hero",
      "files": ["block.json", "index.php", "style.scss"]
    }
  ]
}

Απαιτήσεις

Η φιλοξενία πρέπει να υποστηρίζει άμεση πρόσβαση σε αρχεία μέσω του URL. Το CLI ανακτά αρχεία δημιουργώντας διευθύνσεις URL από το {baseUrl}/{block.name}/{file}.

Το CLI δεν διαθέτει δική του διαδικασία σύνδεσης. Για ιδιωτικά μητρώα, διαχειριστείτε τον έλεγχο πρόσβασης στο επίπεδο φιλοξενίας (e.g. ιδιωτικά repos GitHub με tokens ή διακομιστής που ελέγχει τα διαπιστευτήρια) και ζητήστε από τους καταναλωτές να στέλνουν τα διαπιστευτήρια ως προσαρμοσμένες κεφαλίδες μέσω της μορφής αντικειμένου στο blocks.json.

Δοκιμή του μητρώου σας

Πριν από τη δημοσίευση, δοκιμάστε τοπικά εκκινώντας έναν απλό διακομιστή HTTP:

Κέλυφος
cd my-registry
npx serve .

Στη συνέχεια, ορίστε το blocks.json σας στην τιμή http://localhost:3000/registry.json και εκτελέστε το npx blockstudio list για να επαληθεύσετε ότι επιλύονται όλα. Το list ανακτά μόνο το registry.json. Για να δοκιμάσετε το add, ορίστε το baseUrl σε http://localhost:3000/blocks κατά τη δοκιμή, επειδή το CLI κατεβάζει αρχεία block από το baseUrl.