compio CLI

? Projeto

O Compio tem como finalidade facilitar a criação de novos component custom para o Vtex.io

? Instalação

⚠️ Cuidado
a intalação deve ser efetuada na pasta principal do projeto e não dentro da pasta react! 

  yarn add compio

A cli foi criada pra suportar a seguinte arquitetura de pastas

  ├── ...
  ├── react           # pasta builder React
  │   ├── components
  │   ├── context
  │   └── ...
  │
  ├── store           # pasta builder Store
  │   ├── ...
  │   └── interfaces.json
  │
  ├── manifest.json
  └── ...

? Comandos

Criar um component

yarn compio create:component

serão feitas algumas perguntas para a configuração do componente como:

  • nome do component
  • nome da interface_id
  • se o componente terá um schema para o site editor
  • tipo da composição do componente
    • blocks: caso deseja utilizar o ExtensionPoint para chamar outros componentes. Veja mais sobre
    • children: caso deseja que o seu componente receba filhos.
  • em qual camada seu componente sera renderizado: server, client ou lazy
  • Caso selecione a opção de blocks ira aparecer uma lista dos componentes já resgistrados dentro do interfaces.json para que já possa informar quais poderão ser chamados pelo ExtensionPoint

Criar um context

yarn compio create:context

serão feitas algumas perguntas para a configuração do context como:

  • nome do context
  • nome do interface_id do provider
  • listagem dos componentes já registrados no arquivo interfaces.json para que possa selecionar os componentes em que o contexto ficara disponivel

? documentação utilizada durante o desenvolvimento

??‍? Author:

? licenças

Este projeto é licenciado sobre a licença MIT – LICENSE.md para mais informações.

GitHub

View Github