Σχήμα registry.json
Πλήρες σχήμα
JSON
{
"$schema": "https://blockstudio.dev/schema/registry.json",
"name": "my-registry",
"description": "A collection of WordPress blocks.",
"baseUrl": "https://example.com/blocks",
"blocks": [
{
"name": "hero",
"title": "Hero",
"description": "Full-width hero section with heading and CTA.",
"category": "layout",
"type": "blockstudio",
"dependencies": ["button"],
"files": [
"block.json",
"index.php",
"style.scss"
]
}
]
}
Πεδία ανώτατου επιπέδου
| Πεδίο | Τύπος | Υποχρεωτικό | Περιγραφή |
|---|---|---|---|
$schema |
string |
Όχι | Σχήμα JSON URL για επικύρωση στον επεξεργαστή. |
name |
string |
Ναι | Αναγνωριστικό μητρώου. Δεν μπορεί να είναι κενό. |
description |
string |
Όχι | Σύντομη περιγραφή του μητρώου. |
baseUrl |
string |
Ναι | Βασικό URL για τη λήψη αρχείων block. Πρέπει να είναι έγκυρο URL. |
blocks |
BlockEntry[] |
Ναι | Πίνακας διαθέσιμων block. Πρέπει να περιέχει τουλάχιστον μία εγγραφή. |
Πεδία εγγραφής block
| Πεδίο | Τύπος | Υποχρεωτικό | Περιγραφή |
|---|---|---|---|
name |
string |
Ναι | Όνομα φακέλου block και αναγνωριστικό CLI. Δεν μπορεί να είναι κενό. |
title |
string |
Όχι | Όνομα εμφάνισης φιλικό προς τον χρήστη. |
description |
string |
Όχι | Περιγραφή μίας γραμμής για τα αποτελέσματα αναζήτησης. |
category |
string |
Όχι | Ετικέτα ομαδοποίησης για την έξοδο λίστας. |
type |
"blockstudio" | "create-block" | "wordpress" |
Όχι | Τύπος block. Μόνο για ενημέρωση, δεν επηρεάζει τη συμπεριφορά του CLI. |
dependencies |
string[] |
Όχι | Ονόματα block του ίδιου μητρώου που πρέπει να εγκατασταθούν μαζί με αυτό το block. |
files |
string[] |
Ναι | Διαδρομές αρχείων σχετικές με τον φάκελο του block. Απαιτείται τουλάχιστον ένα αρχείο. |
Επίλυση διαδρομών αρχείων
Κάθε αρχείο λαμβάνεται από:
Κώδικας
{baseUrl}/{block.name}/{file}
Και γράφεται στο:
Κώδικας
{directory}/{block.name}/{file}
Οι υποκατάλογοι στις διαδρομές αρχείων δημιουργούνται αυτόματα.
Κανόνες επικύρωσης
- Το
nameπρέπει να είναι μη κενό τόσο στο επίπεδο του μητρώου όσο και στο επίπεδο του block. - Το
baseUrlπρέπει να είναι έγκυρο URL. - Το
blocksπρέπει να περιέχει τουλάχιστον μία εγγραφή. - Το
filesκάθε block πρέπει να περιέχει τουλάχιστον μία εγγραφή. - Το
type, αν δοθεί, πρέπει να είναι μία από τις τρεις επιτρεπόμενες τιμές. - Το
dependencies, αν δοθεί, πρέπει να είναι πίνακας συμβολοσειρών. Κάθε εξάρτηση πρέπει να υπάρχει στο ίδιο μητρώο, διαφορετικά το CLI θα εμφανίσει σφάλμα κατά την επίλυση.