+3
日增长
18,817
stars
980
forks
61
watchers
4,402
prs
719
issues
192
releases
README
Get Started | Website
Lint commit messages
Demo generated with svg-term-cli
cat docs/assets/commitlint.json | svg-term --out docs/public/assets/commitlint.svg --frame --profile=Seti --height=20 --width=80
[![npm latest][2]][3] [![node compatibility][13]][14] [![Github Actions][4]][5]
- 🚓 Be a good commitizen
- 📦 Share configuration via npm
- 🤖 Tap into conventional-changelog
Contents
- Get Started | Website
- Contents
- What is commitlint
- Benefits of using commitlint
- Getting started
- CLI
- Config
- Shared configuration
- Documentation
- API
- Tools
- Roadmap
- Version Support and Releases
- Releases
- Related projects
- License
- Development
- Install and run
---
What is commitlint
commitlint checks if your commit messages meet the conventional commit format.
In general the pattern mostly looks like this:
sh
type(scope?): subject scope is optional; multiple scopes are supported (current delimiter options: "/", "\" and ",")
Real world examples can look like this:
text
chore: run tests on travis ci
text
fix(server): send cors headers
text
feat(blog): add comment section
Common types according to commitlint-config-conventional (based on the Angular convention) can be:
- build
- chore
- ci
- docs
- feat
- fix
- perf
- refactor
- revert
- style
- test
These can be modified by your own configuration.
Benefits of using commitlint
- Why Use Conventional Commits?
- "The perks of committing with conventions" (Talk slides)
Getting started
- Local setup - Lint messages on commit with husky
- CI setup - Lint messages during CI builds
CLI
- Primary way to interact with commitlint.
- npm install --save-dev @commitlint/cli
- Packages: cli
Config
- Configuration is picked up from:
- .commitlintrc
- .commitlintrc.json
- .commitlintrc.yaml
- .commitlintrc.yml
- .commitlintrc.js
- .commitlintrc.cjs
- .commitlintrc.mjs
- .commitlintrc.ts
- .commitlintrc.cts
- .commitlintrc.mts
- commitlint.config.js
- commitlint.config.cjs
- commitlint.config.mjs
- commitlint.config.ts
- commitlint.config.cts
- commitlint.config.mts
- commitlint field in package.json
- commitlint field in package.yaml
- Packages: cli, core
- See Rules for a complete list of possible rules
- An example configuration can be found at @commitlint/config-conventional
Shared configuration
A number of shared configurations are available to install and use with commitlint:
- @commitlint/config-angular
- @commitlint/config-conventional
- @commitlint/config-lerna-scopes
- @commitlint/config-nx-scopes
- @commitlint/config-patternplate
- @commitlint/config-workspace-scopes
- conventional-changelog-lint-config-atom
- conventional-changelog-lint-config-canonical
⚠️ If you want to publish your own shareable config then make sure it has a name aligning with the pattern commitlint-config-emoji-log or commitlint-config-your-config-name — then in extend all you have to write is emoji-logTop issues
#607How to use parser headerPattern25 comments · 2019-04-02#3559feat: conditional subject-empty22 comments · 2023-03-10#2109Support the Pre-Commit framework with a .pre-commit-hooks.yaml file15 comments · 2020-09-08#896bug: footer-leading-blank complains with the number sign in the commit body15 comments · 2020-01-13#4094fix: Cannot find module '/Users/steven/Desktop/Github/constore-ui/node_modules/inquirer/lib/prompts/input.js'12 comments · 2024-07-03#3615Rule does not work with #ids 12 comments · 2023-05-31#3588fix: SyntaxError: Invalid or unexpected token. commit-msg run error.11 comments · 2023-04-23#3517Sentence-case is not work properly10 comments · 2023-01-31
Latest release
v21.2.4 v21.2.4 2026-10-1821.2.4 (2026-10-18) Bug Fixes fix(load): replace config file arrays with seed arrays by @escapedcat in https://github.com/conventional-changelog/commitlint/pull/5056 fix: update dependency jsonc to v3 by @renovate[bot] in https://github.com/conventional-changelog/commitlint/pull/5020 Performance Improvements perf(load): load typescript configs with jiti directly by @escapedcat in https://github.com/conventional-changelog/commitlint/pull/5052 Docs, etc docs: add AGENTS.md with commit type guidance by @escapedcat in https://github.com/conventional-changelog/commitlint