Introdução ao CommitLint


O commitlint é uma ferramenta que verifica se as mensagens de commit seguem o formato baseado em conventional commits. Esse formato geralmente se parece com:

type(scope?): subject

Nota

scope é opcional; múltiplos escopos são suportados (opções de delimitadores atuais: ”/”, "" e ”,“)

Exemplos:

chore: run tests on travis ci
fix(server): send cors headers
feat(blog): add comment section

Os tipos comuns, de acordo com commitlint-config-conventional (baseado na convenção do Angular), incluem:

  • build
  • chore
  • ci
  • docs
  • feat
  • fix
  • perf
  • refactor
  • revert
  • style
  • test

Nota

Esses tipos podem ser modificados de acordo com sua própria configuração.

Os benefícios de usar o commitlint incluem

  • A padronização das mensagens de commit, facilitando a compreensão do histórico do repositório.
  • O uso de conventional commits também pode ser vantajoso ao integrar ferramentas automatizadas, como geração automática de notas de versão, changelog e integração contínua (CI).

Referências