commitizen / commitizen/cz-cli
Update Documentation for pre-commit hooks with Husky 5
- Linguagem predominante
- JavaScript
- Estrelas
- 17.5k
- Forks
- 566
- Merge médio
- 8h 16min
- PRs com merge (30d)
- 1
Descrição
Hi commitizeners :)
I love using commitizen on my projects, and with husky hooks for pre-commit is great.
BUT... There is a new version of Husky, (Husky 5) which breaks how hooks are set up. That means the commitizen documentation is now out of date (because it only describes from Husky 4).
## PROBLEM:
The commitizen documentation is out of date for Husky 5.
## Main Differences:
In Husky 4, you add a husky hook to package.json and install commitizen and husky. Husky automatically registers the hook.
Now... in Husky 5, the hooks are added to separate files (NOT package.json)
## SOLUTION:
Brief instructions follow, which I suggest to be added to the commitizen documentation.
#### Using Commitizen with Husky 5
Install husky:
npm install--save-dev husky
Then run this to add a pre commit message hook:
npx husky add .husky/prepare-commit-msg "exec < /dev/tty && git cz --hook || true"
Note, you will probably want to add the resulting hook file to git:
.husky/prepare-commit-msg
UPDATE: If your hooks don't run, you can tell Husky to install them:
npx husky install
Hope that is helpful!
Guia de contribuição
Direção de pesquisa
Localize a seção existente da documentação do commitizen que descreve o Husky 4 e compare-a com as instruções do Husky 5 nesta issue, incluindo .husky/prepare-commit-msg e a configuração do pacote. Atualize a documentação para abranger o novo workflow baseado em arquivos de hook e o comando de instalação; em seguida, verifique se as instruções estão corretas.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- git, javascript
- Domínio
- cli, documentation
- Tipo de issue
- Documentação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 38/100