This is my attempt at setting up a project/repo with Commitlint and Husky as fast as possible.
- Commitlint (you guessed it) lints your comments based on conventional commits' Standards
- Husky uses githooks to lint the commits before they are actually executed (pre-commit hook)
You are very welcome to overwrite any of these settings, or just fork the entire thing to create your own.
-
If you don't already have a
package.jsonfile, create one withnpm init. -
Then ensure you have a .git folder create one with
git init. -
In the root of your project execute the following command in your terminal:
npm i commitlint-with-husky --save-dev
I work on a windows machine, to the best of my knowledge the package works on all platforms, if not please don't hesitate to let me know.
Enjoy!