Kamyab7 / ConventionalCommits

Conventional Commit

I try use Conventional Commit and for enforcing its rule I use conventional-changelog/commitlint and typicode/husky with a pre-commit hook. For read more about its setup see commitlint docs and this article.

Here I configured a husky hook for conventional commits:

1. Install NPM:

npm init

2. Install Husky:

npm install husky --save-dev

3. Add prepare command for installing and activating husky hooks in the package.json file:

npm pkg set scripts.prepare="husky install"

4. Install CommitLint:

npm install --save-dev @commitlint/config-conventional @commitlint/cli

5. Create the commitlint.config.js file with this content:

module.exports = { extends: '@commitlint/config-conventional']};

6. Create the Husky folder:

mkdir .husky

7. Link Husky and CommitLint:

# this command should run in git-bash
npx husky add .husky/commit-msg 'npx --no -- commitlint --edit ${1}'

8. Activate and installing all husky hooks with this command:

npm run prepare