📓 Lint commit messages

★ 18,817⑂ 980👁 61⑃ 4,402● 719▤ 192
TypeScriptMITCreated 2016-02-12commitlint.js.org
下载:v21.2.4v21.2.4 ↓21.2.42026-10-18
+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-log

Top issues

Latest release

v21.2.4 v21.2.4 2026-10-18
21.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

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON