@andrevantunes/ribo v1.2.0
RIBO
RIBO é a nossa biblioteca de montagem de componentes.
Explicando o nome: Quando passamos um json para dentro do componente é como se a gente passasse um RNA para a RIBOssomo fazer a síntese dos componentes no front (proteínas). Ribossomo é muito longo, logo Ribo é mais sonoro.
Tabela de Conteúdo
Como usar
Para adicionar o Ribo aos projetos, rode o seguinte comando:
$ yarn add @andrevantunes/riboImportando o RIBO:
:warning: Em construção
Instalação
Para rodar o projeto você precisa clonar a aplicação em usa máquina:
# Clone este repositório
$ git clone git@github.com:andrevantunes/ribo.git
# Acesse a pasta do projeto no terminal/cmd
$ cd ribo
# Instale as dependências
$ yarnPre-requisitos
- Git
- Node.js >= 14 <= 16 (Recomendado)
- Yarn >= 1 <= 2
Os seguintes padrões foram adotados e devem ser seguidos:
Organização dos arquivos
O projeto está organizado da seguinte maneira:
📂src
┣ 📂async-content # componente que usa controller com JST
┣ 📂constraints-content # componente que usa as constraints
┣ 📂ribo # componente recursivo de montagem de componentes
┗ 📜index.ts # arquivo que exporta todos os componentesTestes
Testes unitários e funcionais
Os testes da aplicação usam o RTL (React Testing Library), que trabalham em conjunto com o Jest e o React Test Utils.
Os arquivos de testes unitários devem seguir a extensão .spec.ts.
# Rodando os testes
$ yarn test
# Rodando os testes com watch
$ yarn test:watch
# Rodando os testes com coverage
$ yarn test:coveragePublicação
:warning: Em construção
A publicação do projeto é automatizada e feita toda a vez que um PR é mesclado no branch main.
A geração de tags e publicação é realizado com base no semantic realease, assim como a atualização da documentação contendo a versão mais recente do modulo no npm.
Tecnologias
11 months ago