commitizen / commitizen/cz-cli

Update Documentation for pre-commit hooks with Husky 5

Aperta
#810 1 commento 8 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
JavaScript
Stelle
17.5k
Fork
566
Merge medio
8h 16m
PR unite (30g)
1

Descrizione

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!

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.