Lint commit messages
- 🚓 Be a good
commitizen - 📦 Share configuration via
npm - 🤖 Tap into
conventional-changelog
# Install commitlint cli and angular config
npm install --save-dev @commitlint/{config-angular,cli}
# Configure commitlint to use angular config
echo "module.exports = {extends: ['@commitlint/config-angular']}" > commitlint.config.js- Local setup - Lint messages on commit with husky
- CI setup - Lint messages during CI builds
- Primary way to interact with commitlint.
npm install --save-dev @commitlint/cli- Packages: cli
- Configuration is picked up from
commitlint.config.js,.commitlintrc.js,.commitlintrc.json, or.commitlintrc.ymlfile or acommitlintfield inpackage.json - Packages: cli, core
- See Rules for a complete list of possible rules
- An example configuration can be found at @commitlint/config-angular
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
- Alternative, programatic way to interact with
commitlint npm install --save @commitlint/core- Packages: core
- See API for a complete list of methods and examples
- Node.js LTS
>= 4.8 - git
>= 2
- conventional-changelog – Generate a changelog from conventional commit history
- commitizen – Simple commit conventions for internet citizens
Copyright by @marionebl. All commitlint packages are released under the MIT license.
commitlint is developed in a mono repository.
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 changenpx yarn run clean
npx yarn install
npx yarn run build
npx yarn test
npx yarn run publish