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

Ξεκινώντας

Προαπαιτούμενα

  • Node.js 18+
  • Ένα θέμα ή πρόσθετο WordPress όπου θέλετε να εγκαταστήσετε μπλοκ

Το πακέτο blockstudio στο npm είναι στην έκδοση 0.0.1. Αυτή η έκδοση είναι προσωρινή: περιλαμβάνει μόνο μια εντολή add, η οποία εκτυπώνει Adding block: <name> και τερματίζει χωρίς να ανακτά τίποτα, ενώ απορρίπτει τα init, list, search, remove, --yes και --dry-run ως άγνωστα. Οι εντολές σε αυτές τις σελίδες περιγράφουν το μητρώο CLI στο αποθετήριο Blockstudio (packages/registry).

Αρχικοποίηση του έργου σας

Εκτελέστε το init στη ρίζα του θέματος ή του πρόσθετού σας:

Κέλυφος
npx blockstudio init

Το CLI σάς καθοδηγεί στη διαδραστική ρύθμιση:

  1. Κατάλογος μπλοκ: πού θα εγκαθίστανται τα μπλοκ (προεπιλογή: blockstudio)
  2. Μητρώα: προσθήκη ενός ή περισσότερων URL μητρώων με όνομα

Έτσι δημιουργείται ένα αρχείο blocks.json:

JSON
{
  "$schema": "https://blockstudio.dev/schema/blocks.json",
  "directory": "blockstudio",
  "registries": {
    "ui": "https://blocks.example.com/registry.json"
  }
}

Μπορείτε επίσης να παραλείψετε τις διαδραστικές προτροπές:

Κέλυφος
npx blockstudio init --yes

Έτσι δημιουργείται ένα blocks.json με προεπιλεγμένες τιμές. Μπορείτε έπειτα να το επεξεργαστείτε χειροκίνητα.

Προσθήκη μπλοκ

Κέλυφος
npx blockstudio add ui/tabs

Η μορφή είναι namespace/block, όπου το namespace αντιστοιχεί σε κλειδί στη ρύθμιση registries σας.

Το CLI:

  1. Ανακτά το μητρώο
  2. Εντοπίζει το μπλοκ
  3. Επιλύει τυχόν εξαρτήσεις (e.g. Το tabs εξαρτάται από το tab-item)
  4. Κατεβάζει όλα τα αρχεία
  5. Τα γράφει στον κατάλογο μπλοκ σας

Αν το μπλοκ υπάρχει σε ένα μόνο μητρώο, μπορείτε να παραλείψετε το namespace:

Κέλυφος
npx blockstudio add tabs

Αν υπάρχει σε πολλά μητρώα, το CLI σάς ζητά να επιλέξετε σε τερματικό. Χωρίς τερματικό, διακόπτεται με σφάλμα που παραθέτει τα μητρώα που ταιριάζουν, ενώ το --yes επιλέγει το πρώτο σύμφωνα με τη σειρά blocks.json.

Προσθήκη πολλών μπλοκ

Κέλυφος
npx blockstudio add ui/tabs ui/hero ui/accordion

Όλα τα μπλοκ εγκαθίστανται σε μία εκτέλεση.

Προεπισκόπηση πριν από την εγκατάσταση

Κέλυφος
npx blockstudio add ui/tabs --dry-run

Εμφανίζει τι θα εγκατασταθεί, χωρίς να γράφει αρχεία.

Περιήγηση στα διαθέσιμα μπλοκ

Κέλυφος
npx blockstudio list
npx blockstudio list ui
npx blockstudio search hero

Το list εμφανίζει όλα τα μπλοκ από όλα τα μητρώα (ή από ένα συγκεκριμένο). Το search κάνει αναζήτηση υποσυμβολοσειράς χωρίς διάκριση πεζών και κεφαλαίων στα ονόματα, τους τίτλους και τις περιγραφές των μπλοκ.

Αφαίρεση μπλοκ

Κέλυφος
npx blockstudio remove tabs

Αυτό διαγράφει τον φάκελο του μπλοκ. Σε διαδραστική λειτουργία, θα σας ζητηθεί επιβεβαίωση. Περάστε το --yes για να παραλείψετε την προτροπή.

CI και αυτοματοποίηση

Τα init, add και remove δέχονται το --yes για παράλειψη των διαδραστικών προτροπών. Τα list και search δεν εμφανίζουν ποτέ προτροπές και απορρίπτουν το --yes ως άγνωστη επιλογή. Όταν το stdin δεν είναι τερματικό (σε εκτελεστές CI ή μέσω διοχέτευσης εισόδου), το CLI περνά σε μη διαδραστική λειτουργία: το init αντικαθιστά ένα υπάρχον blocks.json, το add διακόπτεται με σφάλμα αν υπάρχει ήδη φάκελος μπλοκ ή αν ένα όνομα μπλοκ είναι αμφίσημο και το remove διαγράφει χωρίς ερώτηση.

Κέλυφος
npx blockstudio init --yes --directory blockstudio
npx blockstudio add ui/tabs --yes
npx blockstudio remove tabs --yes