Commitlint

Installation

npm i -D @commitlint/cli @commitlint/config-conventional

yarn add -D @commitlint/cli @commitlint/config-conventional

pnpm add -D @commitlint/cli @commitlint/config-conventional

bun add -d @commitlint/cli @commitlint/config-conventional

These are basic .commitlintrc.json settings.

{
  "$schema": "https://json.schemastore.org/commitlintrc.json",
  "extends": ["@commitlint/config-conventional"]
}

Commitlint checks if your commit messages meet the conventional commit format.

Example of valid commit messages:

feat: add new feature
fix: resolve bug in component
docs: update README
chore: update dependencies
style: format code

When configured with husky’s commit-msg hook, it will automatically validate commit messages:

npx --no -- commitlint --edit $1