@dr.cash/components

Instalação

Configuração do eslint no VSCode

1. Baixe a extensão "ESLint"
   1. Aperte ctrl + shift + x para abrir a aba de extensão e pesquise por eslint
2. Configure o editor para executar o comando yarn eslint --fix automaticamente ao salvar algum arquivo
   1. Abra o seu arquivo de settings.json do vscode através do comando ctrl + ,
   2. Aperte em um ícone no canto superior direito, abaixo do ícone de minimizar a aba, ao passar o mouse ele exibe o texto "Open Settings (JSON)"
   3. Adicione este trecho no final do arquivo:

         "editor.codeActionsOnSave": {
           "source.fixAll.eslint": true
         },
         "eslint.validate": ["javascript", "javascriptreact"]
      

   4. Pronto. Agora ao pressionar ctrl + s em algum arquivo, os erros que podem ser resolvidos automaticamente pela extensão do vscode, serão corrigidos.
   5. Aqueles erros que não forem automaticamente corrigidos ao pressionar ctrl + s devem ser analisados e, dependendo da situação, desabilitados no arquivo .eslintrc.js

Como dar manutenção neste pacote:

1. Crie uma branch a partir de dev
2. Para testar o que estivar fazendo em "real time", faça o comando yarn link na sua branch, e, no projeto que importar o componente que está desenvolvendo, faça yarn link @dr.cash/components.
3. Após finalizar o desenvolvimento, faça push em sua branch e crie o PR de sua branch para a dev
4. Após o PR e code review ser aprovado, e ser realizado um merge da dev para master, será necessário atualizar a versão deste pacote npm
   1. Caso seja uma correção pequena, após mergear as alterações, executar npm version patch, consumindo o último número da versão
   2. Caso seja adicionada um novo componente ou alguma nova funcionada de algum componente já existente, executar npm version minor, consumindo o número do meio da versão
   3. Caso seja realizada alguma grande mudança, como por exemplo, redesign de todos os componentes, ou algo que implique no não funcionamento de alguma funcionalidade existente no pacote, executar npm version major, consumindo o primeiro número da versão.
   4. Caso algum erro ocorra neste passo, sendo necessário desfazer o consumo do contador de versão, de uma olhada neste link.
   5. OBS: Veja o arquivo package.json para utilizar os comandos yarn publish:xxx, na qual "xxx" pode ser substituído por patch, minor ou major. É necessário realizar o build do projeto antes de fazer o comando de publicação, os scripts mencionados anteriormente surgiram para garantir que o build será efetuado antes de publicar o pacote, portanto, recomenda-se que os mesmos sejam utilizados.
5. Após realizar o comando no passo anterior, que consome o contador da versão do pacote, será necessário publicar o mesmo através do comando npm publish
6. Após publicar as novas mudanças, os pacotes que dependem deste projeto, devem ter suas versões atualizadas no package.json
   1. No repositório que depende deste projeto, faça os comandos a seguir:
   2. npm unlink @dr.cash/components (Caso tiver feito o link - opicional)
   3. npm uninstall @dr.cash/components
   4. npm install @dr.cash/components

Observações

1. Leia este documento para mais informações sobre publicações de pacotes npm: Publicação de pacotes npm