Saltar al contenido

Primeros pasos

Requisitos previos

  • Node.js 18+
  • Un tema o plugin de WordPress donde quieras instalar bloques

El paquete blockstudio en npm está en la versión 0.0.1. Esa versión es provisional: solo tiene un comando add, que imprime Adding block: <name> y termina sin descargar nada, y rechaza init, list, search, remove, --yes y --dry-run como desconocidos. Los comandos de estas páginas describen el registro CLI en el repositorio Blockstudio (packages/registry).

Inicializa tu proyecto

Ejecuta init en la raíz de tu tema o plugin:

Shell
npx blockstudio init

CLI te guía por una configuración interactiva:

  1. Directorio de bloques: dónde se instalarán los bloques (predeterminado: blockstudio)
  2. Registros: añade una o más URL de registro con un nombre

Esto crea un archivo blocks.json:

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

También puedes omitir las indicaciones interactivas:

Shell
npx blockstudio init --yes

Esto crea un archivo blocks.json con los valores predeterminados. Después puedes editarlo manualmente.

Añade un bloque

Shell
npx blockstudio add ui/tabs

El formato es namespace/block, donde namespace coincide con una clave de tu configuración registries.

CLI:

  1. Obtiene el registro
  2. Busca el bloque
  3. Resuelve las dependencias (e.g. tabs depende de tab-item)
  4. Descarga todos los archivos
  5. Los guarda en el directorio de bloques

Si el bloque solo existe en un registro, puedes omitir el espacio de nombres:

Shell
npx blockstudio add tabs

Si existe en varios registros, CLI te pide que elijas en una terminal. Sin una terminal, se detiene con un error que enumera los registros coincidentes, y --yes elige el primero según el orden de blocks.json.

Añade varios bloques

Shell
npx blockstudio add ui/tabs ui/hero ui/accordion

Todos los bloques se instalan en una sola ejecución.

Vista previa antes de instalar

Shell
npx blockstudio add ui/tabs --dry-run

Muestra lo que se instalaría sin escribir ningún archivo.

Explora los bloques disponibles

Shell
npx blockstudio list
npx blockstudio list ui
npx blockstudio search hero

list muestra todos los bloques de todos los registros (o de uno específico). search busca subcadenas sin distinguir mayúsculas de minúsculas en nombres, títulos y descripciones de bloques.

Elimina un bloque

Shell
npx blockstudio remove tabs

Esto elimina la carpeta del bloque. En modo interactivo, se te pide confirmación. Pasa --yes para omitir la indicación.

CI y automatización

init, add y remove aceptan --yes para omitir las indicaciones interactivas. list y search nunca solicitan confirmación y rechazan --yes como una opción desconocida. Cuando stdin no es una terminal (ejecutores de CI, entrada redirigida), CLI pasa al modo no interactivo: init sobrescribe un blocks.json existente, add se detiene con un error si la carpeta del bloque ya existe o el nombre del bloque es ambiguo, y remove elimina sin preguntar.

Shell
npx blockstudio init --yes --directory blockstudio
npx blockstudio add ui/tabs --yes
npx blockstudio remove tabs --yes