18.8K ·GitHub
What is this?
commitlint checks whether your commit messages meet the conventional commit format, linting them against a configurable rule set.
commitlint checks whether your commit messages meet the conventional commit format, linting them against a configurable rule set.Is it a command-line tool or a library I call from code?Primarily a CLI, @commitlint/cli, that you run against commit messages. There is also a programmatic JavaScript API with lint, load, read and format methods for building it into other tools.
Primarily a CLI, @commitlint/cli, that you run against commit messages. There is also a programmatic JavaScript API with lint, load, read and format methods for building it into other tools.How do I add it to my project?Install @commitlint/cli as a dev dependency, add a commitlint.config.js or .commitlintrc file with your rules, then lint on every commit with husky or during CI builds.
Install @commitlint/cli as a dev dependency, add a commitlint.config.js or .commitlintrc file with your rules, then lint on every commit with husky or during CI builds.What has to be on my machine for it to run?Node.js LTS >= 22.12.0 and git >= 2.13.2 — so a fairly recent Node is required.
Node.js LTS >= 22.12.0 and git >= 2.13.2 — so a fairly recent Node is required.Can I just stay on an older version once it is set up?Not reliably — the project is not sponsored and can't promise timely patch releases for older versions, so for a security fix you may need to send a PR yourself.
Not reliably — the project is not sponsored and can't promise timely patch releases for older versions, so for a security fix you may need to send a PR yourself.Is this a niche experiment or a battle-tested tool?Battle-tested: the README calls commitlint stable and says it is used in various projects as a development tool, and it has about 18.7k GitHub stars.
Battle-tested: the README calls commitlint stable and says it is used in various projects as a development tool, and it has about 18.7k GitHub stars.Which commit types does the standard config recognize?commitlint-config-conventional, based on the Angular convention, ships with build, chore, ci, docs, feat, fix, perf, refactor, revert, style and test — and these can be modified by your own configuration.
commitlint-config-conventional, based on the Angular convention, ships with build, chore, ci, docs, feat, fix, perf, refactor, revert, style and test — and these can be modified by your own configuration.Why would I want conventional commit messages anyway?The README gives three perks: being a good commitizen, sharing configuration via npm, and tapping into conventional-changelog, which generates a changelog from conventional commit history.
The README gives three perks: being a good commitizen, sharing configuration via npm, and tapping into conventional-changelog, which generates a changelog from conventional commit history.Are there ready-made rule sets instead of writing my own config?Yes — shared configs include @commitlint/config-angular, config-conventional, and scope-checking presets for Lerna, Nx, workspaces and Patternplate; community ones follow the commitlint-config- naming pattern.
Yes — shared configs include @commitlint/config-angular, config-conventional, and scope-checking presets for Lerna, Nx, workspaces and Patternplate; community ones follow the commitlint-config- naming pattern.Does it play well with commitizen?Yes, there is a commitizen adapter and an interactive prompt package, @commitlint/prompt-cli — the commitlint repo itself uses it as its own commit script.
Yes, there is a commitizen adapter and an interactive prompt package, @commitlint/prompt-cli — the commitlint repo itself uses it as its own commit script.What are similar projects?husky, react-doctor, stylelint, knip, super-linter, rust-clippy, changesets, openqodex
husky, react-doctor, stylelint, knip, super-linter, rust-clippy, changesets, openqodexWhich topics is it in?commit, lint, linter, version-control, code-quality, best-practices, monorepo, ci, git, devops, npm, automation
commit, lint, linter, version-control, code-quality, best-practices, monorepo, ci, git, devops, npm, automation