Commitlint

Lint commit messages, read commit history like a book.

Lint commit messages to ensure they adhere to a specified convention, improving code quality and team collaboration.

A specification for adding human and machine-readable meaning to commit messages, facilitating better automation and readability.

Installation

Terminal

npm i -D commitlint @commitlint/{cli,config-conventional,types}

Terminal

touch commitlint.config.ts # In root directory

Terminal

echo "npx commitlint --edit $1" > .husky/commit-msg

Terminal

git commit -m "add commitlint" # Should fail

Terminal

git commit -m "chore: add commitlint" # Should fail

Terminal

git commit -m "Chore: add commitlint" # Should fail

Terminal

git commit -m "chore(repo): Add commitlint" # Should fail

Terminal

git commit -m "chore(Repo): Add Commitlint" # Should pass