Başlarken
Ön koşullar
- Node.js 18+
- Blokları kurmak istediğiniz bir WordPress teması veya eklentisi
npm üzerindeki blockstudio paketi 0.0.1 sürümündedir. Bu sürüm bir yer tutucudur: yalnızca add komutuna sahiptir; bu komut hiçbir şey getirmeden Adding block: <name> yazdırıp çıkar ve init, list, search, remove, --yes ve --dry-run değerlerini bilinmeyen olarak reddeder. Bu sayfalardaki komutlar, Blockstudio deposundaki (packages/registry) CLI kayıt deposunu açıklar.
Projenizi başlatın
Temanızın veya eklentinizin kök dizininde init komutunu çalıştırın:
npx blockstudio init
CLI etkileşimli kurulum adımlarında size yol gösterir:
- Blok dizini: blokların kurulacağı yer (varsayılan:
blockstudio) - Kayıt depoları: bir veya daha fazla kayıt deposu URL’sini adlarıyla ekleyin
Bu işlem bir blocks.json dosyası oluşturur:
{
"$schema": "https://blockstudio.dev/schema/blocks.json",
"directory": "blockstudio",
"registries": {
"ui": "https://blocks.example.com/registry.json"
}
}
Etkileşimli istemleri de atlayabilirsiniz:
npx blockstudio init --yes
Bu işlem varsayılan değerlerle bir blocks.json oluşturur. Daha sonra dosyayı elle düzenleyebilirsiniz.
Blok ekleme
npx blockstudio add ui/tabs
Biçim namespace/block şeklindedir; burada namespace, registries yapılandırmanızdaki bir anahtarla eşleşir.
CLI:
- Kayıt deposunu getirir
- Bloğu bulur
- Bağımlılıkları çözümler (e.g.
tabs,tab-itemöğesine bağlıdır) - Tüm dosyaları indirir
- Bunları blok dizininize yazar
Blok yalnızca bir kayıt deposunda varsa ad alanını atlayabilirsiniz:
npx blockstudio add tabs
Birden fazla kayıt deposunda varsa CLI terminalde seçim yapmanızı ister. Terminal yoksa eşleşen kayıt depolarını listeleyen bir hatayla durur; --yes ise blocks.json sırasındaki ilkini seçer.
Birden fazla blok ekleme
npx blockstudio add ui/tabs ui/hero ui/accordion
Tüm bloklar tek çalıştırmada kurulur.
Kurmadan önce önizleme
npx blockstudio add ui/tabs --dry-run
Bu işlem, herhangi bir dosyayı yazmadan nelerin kurulacağını gösterir.
Kullanılabilir bloklara göz atma
npx blockstudio list
npx blockstudio list ui
npx blockstudio search hero
list tüm kayıt depolarındaki (veya belirli bir kayıt deposundaki) blokları gösterir. search, blok adları, başlıkları ve açıklamalarında büyük/küçük harfe duyarsız bir alt dize eşleşmesi yapar.
Blok kaldırma
npx blockstudio remove tabs
Bu işlem blok klasörünü siler. Etkileşimli modda onaylamanız istenir. İstemi atlamak için --yes geçin.
CI ve otomasyon
init, add ve remove, etkileşimli istemleri atlamak için --yes kabul eder.
list ve search hiçbir zaman istem göstermez ve --yes değerini bilinmeyen bir seçenek olarak reddeder.
stdin bir terminal olmadığında (CI çalıştırıcıları, yönlendirilmiş girdi), CLI etkileşimsiz moda geçer: init mevcut bir blocks.json dosyasının üzerine yazar, add blok klasörü zaten varsa veya blok adı belirsizse hatayla durur ve remove sormadan siler.
npx blockstudio init --yes --directory blockstudio
npx blockstudio add ui/tabs --yes
npx blockstudio remove tabs --yes