commitlint + husky + commitizen

conventional_commit_library.md

commitlint + husky + commitizen

0. git init(if project is not git repository).

1. install node:

   brew install node

2. add node_modules and other conventional commit files and folders to .gitignore:

   echo "
   ## conventional commit related files
   node_modules/ 
   .husky/
   commitlint.config.js
   package-lock.json
   package.json
   ">> .gitignore

3. install commitlint:

   npm install @commitlint/{cli,config-conventional} --save-dev

4. export commitlint/config-conventional:

   echo "                  
   module.exports = {                               
       extends: ['@commitlint/config-conventional'],
   };                       
   " >> commitlint.config.js

Husky v7 won't use the hooks configuration from package.json or .huskyrc.json file.
So you should use files like pre-commit, commit-msg, prepare-commit-msg to use the hooks.
see the answer in stackoverflow.

5. install husky:

   npm install husky --save-dev

6. enable git hooks:

   npx husky install

7. make git commit can use git cz hook:

   npx husky add .husky/prepare-commit-msg "exec < /dev/tty && git cz --hook || true"
   

8. add commitlint in husky with commit-msg:

   npx husky add .husky/commit-msg "npx --no-install commitlint --edit"
   echo "$(cat .husky/commit-msg) \"\$1\"" >> .husky/commit-msg

9. install commitizen:

   npm install commitizen --save-dev

10. initialize your project to use the cz-conventional-changelog adapter by typing:

    commitizen init cz-conventional-changelog --save-dev --save-exact

11. finally, use git commit or cz or cz commit or git cz or git-dz to commit with convention.