Padronização de commits com gitmoji

Angelo Luz
Brainny Smart Solutions
3 min readJan 27, 2020

--

Quem nunca teve problema para padronizar seus commits ou um colega que escrevia mensagens incompreensíveis nos seus commits que atire a primeira caneca.

Aqui na Brainny quando iniciamos as operações tínhamos um documento guia de boas práticas a ser seguido, com um guia de emojis para commits e um processo de merge request que nos ajudava, mas mesmo assim tínhamos problemas para padronizar.

Procurando formas de melhorar o processo, meses atrás encontramos o gitmoji, um projeto open source que visa padronizar os emojis dos commits e ajudar no preenchimento das mensagens.

Captura de tela do site gitmoji.carrloscuesta.me

A instalação

Gitmoji pode ser simplesmente utilizado como uma página de guia para padronização de emojis, mas pode ser instalado facilmente via npm para acesso as facilidades via terminal, que é como utilizamos aqui. Para isso, utilize o seguinte comando no seu terminal para instalar ele globalmente.

$ npm i -g gitmoji-cli

Utilização

Com o gitmoji instalando, você já pode utilizar a ferramenta através do utilitário gitmoji via terminal. Através do parâmetro -l é possível visualizar a listagem de todos os emojis e suas respectivas representatividades.

No help é possível observar todos os parâmetros que podem ser utilizados com o gitmoji, e são eles:

--commit, -c    Commit interativo usando o prompt--config, -g    Configuração de preferências gitmoji-cli.--init, -i      Inicializa gitmoji como um commit hook--list, -l      List all the available gitmojis--remove, -r    Remove a previously initialized commit hook--search, -s    Busca gitmojis--update, -u    Sincroniza a lista de emojis com o repositório--version, -v   Imprime a versão instalada do gitmoji-cli

O vídeo abaixo exemplifica o envio de um commit através do gitmoji

Exemplo de commit através do gitmoji

💡Commit Hook

Inicialize o gitmoji como um commit hook e ele será chamado em todos os seus commits.

gitmoji -i

Resultados

Através do utilitário passamos a ter maior padrão nos commits e mensagens, e com a utilização dos emojis uma leitura mais fácil e amigável dos commits, além de um melhor rastreio. A imagem que segue ilustra um repositório que possui seus commits padronizados com gitmoji.

Exemplo de emijos no repositório remoto

Mais?

Também gravei um vídeo mostrando este e outras alternativas para padronização de commits. Dá uma olhada!

Segue a Brainny nas redes

--

--

Angelo Luz
Brainny Smart Solutions

Co-founder & CTO na Brainny/ Professor e Coordenador dos cursos de Graduação e Pós na Faculdade de Tecnologia Senac.