Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adicionado formatador Prettier #240

Merged
merged 18 commits into from
Nov 5, 2024
Merged

Adicionado formatador Prettier #240

merged 18 commits into from
Nov 5, 2024

Conversation

george-gca
Copy link
Contributor

@george-gca george-gca commented Oct 18, 2024

Descrição de PR

Como discutido, adicionei suporte ao formatador Prettier, tanto como pre-commit quanto como validação de PR.

Como quando uma PR é enviada não tem como automaticamente alterar o código, o que dá pra fazer é subir um HTML com o diff, mostrando as mudanças necessárias pro PR passar pela validação do formatador.

Como isso é feito: quando uma PR é feita, eu pego o código da PR e verifico com o Prettier. Se ela não tá de acordo, eu gero um diff do código pré e pós Prettier e mando renderizar com o diff2html. Daí pego esse HTML e subo pro GitHub como um comentário na PR.

Issue relacionado

Motivações

Manter um código limpo e asseado. E bonito.

george-gca and others added 6 commits October 17, 2024 18:15
Signed-off-by: George Araújo <george.gcac@gmail.com>
Signed-off-by: George Araújo <george.gcac@gmail.com>
Signed-off-by: George Araújo <george.gcac@gmail.com>
Signed-off-by: George Araújo <george.gcac@gmail.com>
Signed-off-by: George Araújo <george.gcac@gmail.com>
Copy link

netlify bot commented Oct 18, 2024

Deploy Preview for diciotech ready!

Name Link
🔨 Latest commit 3594743
🔍 Latest deploy log https://app.netlify.com/sites/diciotech/deploys/6712933f04d2110008c43078
😎 Deploy Preview https://deploy-preview-240--diciotech.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Oct 18, 2024

Deploy Preview for diciotech ready!

Name Link
🔨 Latest commit 6bd9130
🔍 Latest deploy log https://app.netlify.com/sites/diciotech/deploys/672a0eff8310650008bf07ad
😎 Deploy Preview https://deploy-preview-240--diciotech.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@george-gca
Copy link
Contributor Author

Como deu pra ver o workflow Prettier code formatter falhou. Isso é de propósito (ainda não subi o código atual formatado.

Ainda não vai aparecer certinho o diff HTML como eu espero que apareça (em um link) porque esse código ainda não tá na main, acho que quando a PR for aceita isso vai se resolver. Mas dá pra ver como é o HTML diff que ele gera.

  1. Clica em Details ao lado do workflow que falhou

image

  1. Expande o Run peter-evans/repository-dispatch@v2 dentro do passo Dispatch information to repository 🗣️

image

  1. Baixa o arquivo que aparece no link. O arquivo é um zip com um html dentro (o GitHub não deixa ser só o HTML). Abrindo o HTML dá pra ver no browser as mudanças necessárias pro código passar pelo Prettier. Algo assim:

image

@levxyca levxyca self-requested a review October 21, 2024 14:29
@levxyca levxyca added the enhancement New feature or request label Oct 21, 2024
@levxyca levxyca added this to the v2 milestone Oct 21, 2024
@levxyca levxyca linked an issue Oct 21, 2024 that may be closed by this pull request
george-gca and others added 2 commits October 21, 2024 16:26
Signed-off-by: George Araújo <george.gcac@gmail.com>
@george-gca
Copy link
Contributor Author

Pronto, apliquei o Prettier no código e subi.

george-gca and others added 6 commits October 22, 2024 13:04
Signed-off-by: George Araújo <george.gcac@gmail.com>
Signed-off-by: George Araújo <george.gcac@gmail.com>
Signed-off-by: George Araújo <george.gcac@gmail.com>
Signed-off-by: George Araújo <george.gcac@gmail.com>
Signed-off-by: George Araújo <george.gcac@gmail.com>
@george-gca
Copy link
Contributor Author

Mudei tudo porque eu encontrei finalmente um workflow pra rodar o prettier na PR e já subir a modificação. Então toda vez que alguém criar uma PR ele já vai rodar o prettier em tudo e criar um commit extra com o código modificado.

Por algum motivo o Prettier não rodou nos arquivos sass (não sei se ele suporta) então eu mudei os sass todos pra virarem scss. No fundo é uma mudança pequena, e o scss é mais parecido com o css tradicional.

george-gca and others added 4 commits October 25, 2024 12:36
Signed-off-by: George Araújo <george.gcac@gmail.com>
Signed-off-by: George Araújo <george.gcac@gmail.com>
Copy link
Owner

@levxyca levxyca left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bora testar 😄 Não vejo problema também em mudar de SASS para SCSS, precisamos atualizar essa documentação aqui também nesse caso, certo @george-gca? https://github.com/levxyca/diciotech/blob/main/CONTRIBUTING.md#1-instale-um-pr%C3%A9-processador-sass

@levxyca levxyca merged commit 7534878 into levxyca:main Nov 5, 2024
5 of 6 checks passed
@george-gca george-gca deleted the prettier branch November 5, 2024 13:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Usar alguma ferramenta para padronizar o código
2 participants