commitizen / commitizen/cz-cli
Update Documentation for pre-commit hooks with Husky 5
- Langage dominant
- JavaScript
- Étoiles
- 17.5k
- Forks
- 566
- Merge moyen
- 8 h 16 min
- PR mergées (30 j)
- 1
Description
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!
Guide de contribution
Ouvrir le guide de contribution
Piste de recherche
Repérez la section existante de la documentation de commitizen qui décrit Husky 4 et comparez-la avec les instructions concernant Husky 5 dans cette issue, notamment .husky/prepare-commit-msg et la configuration du package. Mettez à jour la documentation pour couvrir le nouveau workflow basé sur des fichiers de hook et la commande d’installation, puis vérifiez que les instructions sont exactes.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- git, javascript
- Domaine
- cli, documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 38/100