Fernanda-Kipper / eventostec-frontend

47 stars 14 forks source link

Adiciona eslint e prettier para padronizar o estilo de código #3

Closed AnndreJunior closed 1 month ago

AnndreJunior commented 1 month ago

Como é um projeto open-source, achei que seria interessante adicionar algum padrão de escrita e linting para manter um certo nível de consistência de código. O eslint está usando a configuração do angular e o prettier tentei deixar parecido com o jeito que o código já estava escrito

Também adicionei as bibliotecas husky e lint-staged, essas duas libs juntas permitem que apenas sejam commitados os arquivos html e ts que estejam com o linting e estilização que foram configurados. Também é possível permitir que o commit só seja feito se os testes passarem, mas, pelo menos por agora, prefiri deixar apenas para linting e estilização com prettier

Também foi feito uma leve refatoração para corrigir o linting e formatar o código já existente, nada que mude funcionalidades

BernardoSemiOficial commented 1 month ago

🚀

wellwelwel commented 1 month ago

Fala, @AnndreJunior 🙋🏻‍♂️

Uma sugestão ao invés de adicionar husky e lint-staged, seria automatizar o processo de linting em um CI que seria executado para cada push em Pull Requests.

É possível que o contribuidor não se atente a configurar o husky, ou ele apenas não ser instalado junto com o npm i (como é no caso de um projeto que participo) ou até casos mais específicos como usar npm install --ignore-scripts.

Com o CI, o fluxo causará um erro no próprio GitHub, independente de qualquer ação local desconhecida do contribuidor.


Sobre as mensagens dos commits, o membro ou colaborador do repositório pode optar por permitir o merge apenas com o uso de Squash and Merge no próprio GitHub.

Por padrão, o GitHub usa a mensagem do commit quando for um único commit ou o título do Pull Request para múltiplos commits, onde o membro ou colaborador do repositório pode alterar a mensagem do commit e agrupar todos os commits do Pull Request em um único commit.


O que acha?

AnndreJunior commented 1 month ago

Não sabia que dava para fazer isso pela própria CI do github, gostei muito da ideia, achei até melhor que o husky e o lint-staged kkkkkkkkk A parte da mensagem entendi mais ou menos, não sou o maior expert de github, mas pelo que pesquisei só o proprietário do repositório pode fazer isso, corriga-me se eu estiver errado

Mas sobre a parte da CI, gostei muito da ideia, depois irei fazer isso e abrir um pr, ainda não estou estudando angular, então tô tentando contribuir como posso

wellwelwel commented 1 month ago

A parte da mensagem entendi mais ou menos, não sou o maior expert de github, mas pelo que pesquisei só o proprietário do repositório pode fazer isso, corriga-me se eu estiver errado

É isso mesmo (membros e colaboradores também) 🙋🏻‍♂️

emnesty commented 1 month ago

Então, acabei de subir meu primeiro PR e não me atentei a isso kkk até pq não manjo 👀