Configuração do CommitLint §

---

Para começar, instale o commitlint e um conjunto de regras específico como dependência de desenvolvimento no seu projeto. Se estiver utilizando o NPM, use os seguintes comandos:

$ npm install --save-dev @commitlint/{cli,config-conventional}

Se você estiver usando o Windows, utilize o seguinte comando:

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

Em seguida, configure o Commitlint para usar a configuração padrão de conventional commits. Crie um arquivo chamado commitlint.config.js e adicione o seguinte conteúdo:

// commitlint.config.js
module.exports = { extends: ['@commitlint/config-conventional'] };

Ou utilize o seguinte comando para automatizar isso:

$ echo "module.exports = { extends: ['@commitlint/config-conventional'] };" > commitlint.config.js

Nota

Alternativamente, você pode definir essa configuração em outros formatos, como .commitlintrc.js, .commitlintrc, .commitlintrc.json ou .commitlintrc.yml.

Instalação do Husky §

O Husky é uma ferramenta para gerenciar hooks do Git. Instale-o como uma dependência de desenvolvimento:

$ npm install husky --save-dev

Em seguida, ative os hooks executando:

$ npx husky install

Adição do hook de Commitlint §

Adicione o hook de commit-msg para garantir que as mensagens de commit atendam às regras definidas pelo commitlint:

$ npx husky add .husky/commit-msg 'npx --no -- commitlint --edit ${1}'

Ou, se preferir usar o pacote instalado:

$ npm pkg set scripts.commitlint="commitlint --edit"
$ npx husky add .husky/commit-msg 'npm run commitlint ${1}'

Atenção

Atualmente, o @commitlint/cli não suporta Yarn v2 Plug’n’Play. Consulte a documentação do Husky para obter informações sobre como ativar automaticamente os ganchos do Git após a instalação em diferentes versões do Yarn.

Referências §

---

• Guide: Local setup