Pierwsze kroki
Wymagania wstępne
- Node.js 18+
- Motyw lub wtyczka WordPress, w których chcesz instalować bloki
Pakiet blockstudio w npm ma wersję 0.0.1. To wydanie jest atrapą: zawiera tylko polecenie add, które wyświetla Adding block: <name> i kończy działanie bez pobierania czegokolwiek, a opcje init, list, search, remove, --yes i --dry-run odrzuca jako nieznane. Polecenia opisane na tych stronach dotyczą rejestru CLI w repozytorium Blockstudio (packages/registry).
Inicjalizacja projektu
Uruchom init w katalogu głównym motywu lub wtyczki:
npx blockstudio init
CLI przeprowadza interaktywną konfigurację:
- Katalog bloków: miejsce instalacji bloków (domyślnie:
blockstudio) - Rejestry: dodaj co najmniej jeden rejestr, podając jego URL i nazwę
Tworzy to plik blocks.json:
{
"$schema": "https://blockstudio.dev/schema/blocks.json",
"directory": "blockstudio",
"registries": {
"ui": "https://blocks.example.com/registry.json"
}
}
Możesz też pominąć interaktywne monity:
npx blockstudio init --yes
Tworzy to plik blocks.json z wartościami domyślnymi. Możesz go później ręcznie edytować.
Dodawanie bloku
npx blockstudio add ui/tabs
Format to namespace/block, gdzie namespace odpowiada kluczowi w konfiguracji registries.
CLI:
- Pobiera dane z rejestru
- Wyszukuje blok
- Rozpoznaje zależności (e.g.
tabszależy odtab-item) - Pobiera wszystkie pliki
- Zapisuje je w katalogu bloków
Jeśli blok znajduje się tylko w jednym rejestrze, możesz pominąć przestrzeń nazw:
npx blockstudio add tabs
Jeśli znajduje się w kilku rejestrach, CLI prosi o wybór w terminalu. Bez terminala przerywa działanie z błędem zawierającym listę pasujących rejestrów, a --yes wybiera pierwszy z nich w kolejności blocks.json.
Dodawanie wielu bloków
npx blockstudio add ui/tabs ui/hero ui/accordion
Wszystkie bloki są instalowane podczas jednego uruchomienia.
Podgląd przed instalacją
npx blockstudio add ui/tabs --dry-run
Pokazuje, co zostałoby zainstalowane, bez zapisywania jakichkolwiek plików.
Przeglądanie dostępnych bloków
npx blockstudio list
npx blockstudio list ui
npx blockstudio search hero
list wyświetla wszystkie bloki ze wszystkich rejestrów lub z wybranego rejestru. search wyszukuje ciąg znaków w nazwach, tytułach i opisach bloków bez uwzględniania wielkości liter.
Usuwanie bloku
npx blockstudio remove tabs
Usuwa folder bloku. W trybie interaktywnym pojawia się prośba o potwierdzenie. Przekaż --yes, aby pominąć monit.
CI i automatyzacja
Polecenia init, add i remove przyjmują --yes, aby pominąć interaktywne monity.
Polecenia list i search nigdy nie wyświetlają monitów i odrzucają --yes jako nieznaną opcję.
Gdy stdin nie jest terminalem (np. w narzędziach CI lub przy wejściu przekierowanym potokiem), CLI przechodzi w tryb nieinteraktywny: init nadpisuje istniejący plik blocks.json, add kończy działanie błędem, jeśli folder bloku już istnieje lub nazwa bloku jest niejednoznaczna, a remove usuwa bez pytania.
npx blockstudio init --yes --directory blockstudio
npx blockstudio add ui/tabs --yes
npx blockstudio remove tabs --yes