Padronização de mensagens de commit com o Husky

O Husky é uma ferramenta incrível que pode ajudar a padronizar as mensagens de commit em seu projeto. Ele funciona como um hook do git e pode ser configurado para validar e formatar as mensagens de commit antes que elas sejam enviadas para o repositório. Isso é útil para garantir que todas as mensagens de commit sejam escritas de acordo com um padrão específico e sejam consistentes com o resto do projeto.

Para começar a usar o Husky em seu projeto, basta instalá-lo como uma dependência do npm.

npm install husky --save-dev

Em seguida, basta adicionar as configurações do Husky ao arquivo package.json.

"husky": {
  "hooks": {
    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
  }
}

Essa configuração específica do Husky irá usar o commitlint para validar e formatar as mensagens de commit. Você também pode usar outras ferramentas, como o Conventional Commits, para ajudar a padronizar as mensagens de commit.

Além disso, é importante configurar o commitlint com as regras de formatação desejadas. Isso pode ser feito adicionando o commitlint-config-padrão como uma dependência do npm e adicionando as configurações ao arquivo package.json.

npm install @commitlint/config-conventional --save-dev

"commitlint": {
  "extends": [
    "@commitlint/config-conventional"
  ]
}

Agora, toda vez que um commit for realizado no seu projeto, o Husky irá validar a mensagem de commit de acordo com as regras configuradas pelo commitlint. Se a mensagem de commit não estiver de acordo com o padrão especificado, o Husky exibirá uma mensagem de erro e o commit não será enviado.

O uso do Husky é uma ótima maneira de garantir que todas as mensagens de commit em um projeto sejam padronizadas e de fácil compreensão. Isso ajuda a manter o histórico de commit limpo e organizado, facilitando a colaboração com outros desenvolvedores e a manutenção do projeto ao longo do tempo.

Fim 😗🖖🏻

Com isso, encerro por aqui e espero que com dica rápida te ajude a manter o histórico de commit limpo e organizado.

— Você pode me seguir no LinkedIn e no Github também. 💖

Referências 🧐

Husky - Git hooks

Conventional Commits