attraction-package-eslint-prettier v1.0.3

attraction-package-eslint-prettier

Repositório para biblioteca de eslint e prettier para o frontend do Attraction.

🚩 Pré-requisito

• Nodejs

git clone git@gitlab.com:zenvia/conversion/libs/zcc-conversion-ui-kit.git

Como testar minhas alterações localmente

Você pode utilizar o storybook para documentar seus componentes e validar suas alterações.

Mas também é possivel rodar o build local da biblioteca de componentes e vinculando no projeto que está testando.

Para isso utilizaremos o Yalc

npm i yalc -g

O Yalc atua como um repositório local para seus pacotes desenvolvidos localmente, possibilitando compartilhamento em seu ambiente local de uma forma simples. ✨

Adicionando o projeto

Para registrar suas alterações atuais no repositório local

# Navegue para o 'zcc-ui-kit'
cd packages/zcc-ui-kit

# Isso irá guardar a biblioteca no repositório do yalc
yalc publish

Sendo gerado a confirmação:

@conversion/zcc-ui-kit@1.5.0 published in store.

Agora você precisa navegar no projeto que precisa ser usado a versão local do seu ambiente. Abra outro terminal e vá até o projeto

cd zcc-conversion-frontend/apps/settings

yalc add @conversion/zcc-ui-kit

Isso irá corresponder as atualizações do projeto em sua maquina e não a versão do npm

Sendo gerado a confirmação:

Package @conversion/zcc-ui-kit@1.5.0 added ==> /home/leonardosantos/Projetos/conversion/zcc-conversion-frontend/apps/settings/node_modules/@conversion/zcc-ui-kit

Observe que no package.json, o apontamento está para o arquivo do yalc.

• + "@conversion/zcc-ui-kit": "file:.yalc/@conversion/zcc-ui-kit", +
• - "@conversion/zcc-ui-kit": "1.4.8", -

Caso o projeto já esteja rodando, reinicie pois ele irá rodar com o build do link 🎉

Atualizei o componente, o que preciso fazer?

Primeiramente, garanta que esteja rodando localmente o projeto, assim sempre será gerado um novo build a cada modificação

npm run dev

Toda vez que houver atualizações, é necessário atualizar o repositório do yalc Para isso basta executar, no terminal do 'zcc-ui-kit'

yalc push

O comando 'push' serve para que, automaticamente todos os projetos linkados estejam sendo atualizados, evitando que você utilize o update em cada um. Em alguns casos, pode ser necessário reiniciar o servidor que está inicializado o projeto front-end.

Removendo o projeto após alterações

Para remover o projeto e parar com o link, é necessário executar o comando

yalc remove @conversion/zcc-ui-kit

Observe que no package.json, o apontamento volta para o original.

• + "@conversion/zcc-ui-kit": "1.4.8", +
• - "@conversion/zcc-ui-kit": "file:.yalc/@conversion/zcc-ui-kit", -

Caso não surja efeito sem suas alterações após a remoção, possivelmente é necessário realizar a instalação novamente das dependências no projeto raiz do zcc-conversion-frontend