Pre commit hooks

[george-gca]

Descrição de PR

Como discutido em #171 seria legal dividir o dicionário por letra e ordenar por ordem alfabética pela chave. Fui pesquisar sobre como fazer isso e a melhor solução que eu encontrei foi como um pre-commit hook.

Basicamente toda vez que uma pessoa usuária realizar um git commit ... alguns processos serão rodados automaticamente para realizar algumas validações/modificações. Acredito até que talvez dê pra tirar a ação de validação do JSON, mas não tenho certeza ainda.

Motivações

Basicamente esse pre-commit hook realiza algumas coisas:

• end-of-file-fixer: garante que os arquivos terminem com um \n e nada além disso (por exemplo espaços em branco)
• check-json: valida a sintaxe dos arquivos json
• check-yaml: valida a sintaxe dos arquivos yml
• format-data: ordena as entradas nos arquivos json dentro da pasta assets/data/

Informações adicionais

Explicando melhor o format-data:

• ele roda run_on_data_changed.sh, que basicamente busca por arquivos que estão dentro do commit e são de arquivos dentro de assets/data/ e passa eles como parâmetro pro arquivo format_data.py
• o format_data.py abre o arquivo JSON e faz as seguintes alterações:
  • ordena os cards pelo título do card, ignorando maiúsculas
  • ordena as tags dentro do card em ordem alfabética, ignorando maiúsculas
  • ordena as chaves dentro do card em ordem alfabética inversa, o que vai resultar nas chaves ficando title, tags, description e content, o que eu acho que fica melhor pra alguém ler nessa ordem.

Eu decidi não commitar o arquivo assets/data/cards_pt-br.json pra ti poderes testar como funciona isso. Pra testar é só fazer uma alteração qualquer no arquivo como, sei lá, adicionar uma letra aleatória dentro do título de um card, e ver a mágica acontecer 🧙🏽‍♂️. Na 1a modificação ele vai reordenar todo o arquivo (que tá em ordem qualquer), mas nos próximos commits feitos ele vai facilitar o merge acredito eu porque vai reduzir a chance de sempre estarem editando as mesmas partes do arquivo.

[netlify]

✅ Deploy Preview for diciotech ready!

Name	Link
🔨 Latest commit	9feb9a1
🔍 Latest deploy log	https://app.netlify.com/sites/diciotech/deploys/66fc14d5381c34000886b356
😎 Deploy Preview	https://deploy-preview-198--diciotech.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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

[levxyca]

CARACAAAAAAAA, sensacional! Adorei 💙 Criei uma branch teste a partir da sua aqui e funcionou muito bem!!! Com certeza isso vai facilitar demais, obrigada por contribuir!

Pode adicionar o commit do arquivo de cards também agora @george-gca! Feito isso já dou o merge!

[george-gca]

Fiz 1 mudança que só percebi agora, a palavra Época tava sendo a última dos cards porque a comparação não ignorava acentos. Resolvi isso e subi o arquivo ordenado.

[levxyca]

Boa!!!!!! Thanks 🚀🔥