README.md

Lint commit messages

commitlint

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

Contents

• Getting started
• CLI
• Config
• Shared configuration
• API
• Tools
• Version Support
• Related projects
• License
• Development
  • Install and run
  • Publishing a release

---

Getting started

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

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

• 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:

• @commitlint/config-angular
• @commitlint/config-conventional
• @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 >= 4.8
• git >= 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

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

Development

commitlint is developed in a mono repository.

Install and run

git clone [email protected]:marionebl/commitlint.git
cd commitlint
npx yarn install
npx yarn run build # run build tasks
npx 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

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