Seed a Bit logo

Seed a Bit

Github

Introdução

Você não precisará mais se preocupar em executar manualmente tarefas de linting, testes e formatação de código antes de fazer um commit ou push para o repositório. O Husky cuidará disso para você, garantindo que seu código esteja sempre limpo e funcional.

No nosso ecossistema de desenvolvimento, o Husky é uma ferramenta essencial para manter um fluxo de trabalho consistente e eficiente. Ele já vem configurado e você não precisará se preocupar em configura-lo

O que é?

O Husky é uma ferramenta que permite automatizar tarefas de pré-commit e pré-push em repositórios Git. Ele é altamente configurável e pode ser usado para garantir a qualidade do código e evitar erros comuns no desenvolvimento de software. Com o Husky, você pode:

  • Executar tarefas de linting, testes e formatação de código antes de fazer um commit ou push.
  • Garantir que seu código esteja sempre limpo e funcional.
  • Manter um fluxo de trabalho consistente e eficiente em um projeto.
  • Evitar erros comuns e práticas inseguras.

Instalação

Para instalar o Husky em seu projeto, você pode executar o seguinte comando no terminal:

npm install husky --save-dev

Configuração

Após a instalação, você pode configurar o Husky no nos arquivos do diretório .husky na raiz do seu projeto. Crie o arquivo de acordo com o hook do Git que deseja configurar, como pre-commit ou pre-push.

Em nosso projeto temos 2 hooks configurados:

  • pre-commit: Executa tarefas de linting e testes antes de fazer um commit.
  • commit-message: Verifica se a mensagem de commit segue o padrão estabelecido.

No pre-commit, configuramos o Husky para executar o ESLint antes de fazer um commit. Isso garante que o código esteja limpo e sem erros antes de ser enviado para o repositório, mantendo a qualidade do código.

O ESLint não permitiria o código de ir para produção se houvesse algum erro de linting.

No commit-message, configuramos o Husky para verificar se a mensagem de commit segue o padrão estabelecido. Isso ajuda a manter um histórico de commits limpo e organizado, facilitando a revisão e a colaboração no projeto.

Uso

O Husky é ativado automaticamente quando você executa um comando de commit ou push no Git. Ele executa as tarefas configuradas nos arquivos do diretório .husky. Ele também está configurado para funcionar com o Github Desktop.