commitizen / commitizen/cz-cli
husky doesn't cause issues with script named commit
- Vorherrschende Sprache
- JavaScript
- Sterne
- 17.5k
- Forks
- 566
- Ø Merge
- 8 Std. 16 Min.
- Gemergte PRs (30 T.)
- 1
Beschreibung
This section from the README doesn't seem valid anymore. I've been using a script called `"commit"` with a husky `"precommit"` hook without any issues.
Unless I'm missing something this can be removed.
```
NOTE: if you are using precommit hooks thanks to something like husky, you will need to name your script some thing other than "commit" (e.g. "cm": "git-cz"). The reason is because npm-scripts has a "feature" where it automatically runs scripts with the name prexxx where xxx is the name of another script. In essence, npm and husky will run "precommit" scripts twice if you name the script "commit," and the work around is to prevent the npm-triggered precommit script.
```
Beitragsleitfaden
Rechercherichtung
Öffne die README und suche den Hinweis zur Benennung eines Scripts als "commit" neben einem Husky-"precommit"-Hook. Überprüfe das dokumentierte Verhalten mit dem aktuellen Projekt-Setup oder einem minimalen npm-script-Beispiel und entferne oder aktualisiere anschließend den Hinweis, sodass die README mit dem beobachteten Verhalten übereinstimmt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 1/5
- Geschätzter Aufwand
- Unter einer Stunde
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 45/100