Lint commit messages

commitlint

• 🚓 Enforce commit conventions
• 🤖 Plays nicely with conventional-changelog
• 📦 Supports shareable configuration

Getting started

npm install --save-dev @commitlint/{angular,cli}
echo "module.exports = {extends: ['@commitlint/config-angular']}" > commitlint.config.js

CLI

• Primary way to interact with commitlint.
• npm install --save-dev @commitlint/cli
• Packages: cli

Config

• Configuration is picked up from commitlint.config.js files
• Packages: cli, core
• See Rules for a complete list of possible rules
• An example configurations can be found at @commitlint/config-angular

Shared configurations

A number of shared configurations are available to install and use with commitlint:

• @commitlint/config-angular
• @commitlint/config-lerna-scopes
• @commitlint/config-patternplate
• conventional-changelog-lint-config-atom
• conventional-changelog-lint-config-canonical

API

• Alternative, programatic way to interact with commitlint
• npm install --save @commitlint/core
• Packages: core
• See API for a complete list of methods and examples

Tools

• commitizen adapter
• prompt

Version Support

• Node.js LTS version and higher: >= 4
• git >= 2

Related projects

• conventional-changelog – Generate a changelog from conventional commit history
• commitizen – Simple commit conventions for internet citizens

License

Copyright by @marionebl. All commitlint packages are released under the MIT license.

Development

commitlint is developed in a mono repository.

Getting started

git clone git@github.com:marionebl/commitlint.git
cd commitlint
npm install
npm start # run tests, again on change
npm run build # run build tasks