Get Started | Let's chat | Website

Lint commit messages

Demo generated with svg-term-cli

cat docs/assets/commitlint.json | svg-term --out docs/assets/commitlint.svg --frame --profile=Seti --height=20 --width=80

🚓 Be a good commitizen
📦 Share configuration via npm
🤖 Tap into conventional-changelog

What is commitlint
- Benefits using commitlint
Getting started
CLI
Config
Shared configuration
API
Tools
Roadmap
Version Support
Related projects
License
Development
- Install and run
- Publishing a release

What is commitlint

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

In general the pattern mostly looks like this:

type(scope?): subject  #scope is optional

Real world examples can look like this:

chore: run tests on travis ci

fix(server): send cors headers

feat(blog): add comment section

Common types according to commitlint-config-conventional (based on the the Angular convention) can be:

build
ci
chore
docs
feat
fix
perf
refactor
revert
style
test

These can be modified by your own configuration.

Benefits using commitlint

Getting started

# Install commitlint cli and conventional config
npm install --save-dev @commitlint/{config-conventional,cli}
# For Windows:
npm install --save-dev @commitlint/config-conventional @commitlint/cli

# Configure commitlint to use conventional config
echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js

To lint commits before they are created you can use Husky's 'commit-msg' hook.

Install in your project npm install husky --save-dev or yarn add -D husky.

After that, you can create a .huskyrc file or add to your package.json the following code:

{
  "husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  }
}

Detailed Setup instructions

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 commitlint.config.js, .commitlintrc.js, .commitlintrc.json, or .commitlintrc.yml file or a commitlint field in package.json
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:

⚠️ 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 or your-config-name.

API

Alternative, programmatic way to interact with commitlint
Packages:
- format - Format commitlint reports
- lint - Lint a string against commitlint rules
- load - Load shared commitlint configuration
- read - Read commit messages from a specified range or last edit
See API for a complete list of methods and examples

Tools

Roadmap

Ideas: conventional-changelog/commitlint#94

commitlint is considered stable and is used in various projects as development tool.

We identify ease of adoption and developer experience as fields where there is room and need for improvement. The items on the roadmap should enhance commitlint regarding those aspects.

Adoption: Provide reusable Travis CI integration: @commitlint/travis-cli (https://github.com/conventional-changelog/commitlint/releases/tag/v5.1.0)
DX: Support PR squash scenario via ahmed-taj/commitlint-bot and @commitlint/travis-cli
Adoption: Make ahmed-taj/commitlint-bot configurable via commitlint configuration
Adoption: Create commitlint init
DX: Extend the configuration schema to allow for additional fields (descriptions, examples, fixes) on both the rule and value level
DX: Incorporate an extended version of lennym/commit-template deducing a template from commitlint configuration
DX: Rewrite @commitlint/prompt for better usability (might involve a lot of yak-shaving)

Version Support

Node.js LTS >= 8
git >= 2.13.2

Related projects

conventional-changelog – Generate a changelog from conventional commit history
commitizen – Simple commit conventions for internet citizens
create-semantic-module – CLI for quickly integrating commitizen and commitlint in new or existing projects

License

Development

commitlint is developed in a mono repository.

Install and run

git clone git@github.com:conventional-changelog/commitlint.git
cd commitlint
yarn
yarn run build # run build tasks
yarn start # run tests, again on change

For more information on how to contribute please take a look at our contribution guide.

Publishing a release

yarn clean
yarn install
yarn run build
yarn test
yarn run publish

BorisNaguet/commitlint