Primeiros passos
Pré-requisitos
- Node.js 18+
- Um tema ou plugin WordPress onde você quer instalar blocos
O pacote blockstudio em npm está na versão 0.0.1. Essa versão é provisória: só tem um comando add, que exibe Adding block: <name> e termina sem buscar nada, e rejeita init, list, search, remove, --yes e --dry-run como desconhecidos. Os comandos destas páginas descrevem o CLI de registro no repositório Blockstudio (packages/registry).
Inicialize seu projeto
Execute init na raiz do seu tema ou plugin:
npx blockstudio init
CLI orienta você durante a configuração interativa:
- Diretório de blocos: onde os blocos devem ser instalados (padrão:
blockstudio) - Registros: adicione uma ou mais URLs de registro por nome
Isso cria um arquivo blocks.json:
{
"$schema": "https://blockstudio.dev/schema/blocks.json",
"directory": "blockstudio",
"registries": {
"ui": "https://blocks.example.com/registry.json"
}
}
Você também pode ignorar as solicitações interativas:
npx blockstudio init --yes
Isso cria um blocks.json com os valores padrão. Você pode editá-lo manualmente depois.
Adicione um bloco
npx blockstudio add ui/tabs
O formato é namespace/block, em que namespace corresponde a uma chave na sua configuração registries.
O CLI:
- Busca o registro
- Encontra o bloco
- Resolve todas as dependências (e.g.
tabsdepende detab-item) - Baixa todos os arquivos
- Grava-os no diretório do seu bloco
Se o bloco existir em apenas um registro, você pode omitir o namespace:
npx blockstudio add tabs
Se existir em vários registros, CLI solicitará que você escolha no terminal. Sem um terminal, o comando será interrompido com um erro que lista os registros correspondentes, e --yes escolherá o primeiro na ordem de blocks.json.
Adicione vários blocos
npx blockstudio add ui/tabs ui/hero ui/accordion
Todos os blocos são instalados em uma única execução.
Pré-visualize antes de instalar
npx blockstudio add ui/tabs --dry-run
Isso mostra o que seria instalado sem gravar nenhum arquivo.
Explore os blocos disponíveis
npx blockstudio list
npx blockstudio list ui
npx blockstudio search hero
list mostra todos os blocos de todos os registros (ou de um registro específico). search faz uma correspondência de substring sem distinção entre maiúsculas e minúsculas nos nomes, títulos e descrições dos blocos.
Remova um bloco
npx blockstudio remove tabs
Isso exclui a pasta do bloco. No modo interativo, será solicitada uma confirmação. Passe --yes para ignorar a solicitação.
CI e automação
init, add e remove aceitam --yes para ignorar as solicitações interativas. list e search nunca solicitam confirmação e rejeitam --yes como opção desconhecida. Quando a entrada padrão não é um terminal (executores de CI, entrada redirecionada), CLI usa o modo não interativo: init substitui um blocks.json existente, add para com um erro se a pasta do bloco já existir ou se o nome do bloco for ambíguo, e remove exclui sem perguntar.
npx blockstudio init --yes --directory blockstudio
npx blockstudio add ui/tabs --yes
npx blockstudio remove tabs --yes