About commitlint
commitlint checks commit messages against a set of rules. It helps teams keep a consistent commit convention and catches weak messages early.
What it does
You install commitlint with a config file that sets the rules, and it checks each commit message when it is written. Rules can be shared through npm-installed configurations, so several projects can use the same convention. It can also run in continuous integration, so messages are checked again before a change is merged.
Key features
- Checks commit messages against rules
- Shared configs installed from npm
- Runs when a commit is made
- Can run in continuous integration
- Works with the Conventional Commits format
Who it's for
commitlint suits JavaScript teams and projects that want a consistent history and reliable changelogs. It is often paired with a Git hook manager so the checks run on every commit.
Pricing and good to know
commitlint is MIT licensed and free to use. It runs on Node.js, so the project needs Node installed. Teams should agree on the rules first, because a strict rule set can slow down contributors who are new to the convention.
Highlights
- Checks commit messages against your rules
- Shares rule sets through npm packages
- Runs when a commit is made
- Runs again in continuous integration
