commitlint-config-armour

My shareable config for commitlint, see COMMIT_CONVENTION.md for detailed explanation.

Usage

Installation

npm i commitlint-config-armour

or

yarn add commitlint-config-armour

or

npx commitlint-config-armour

Define the config for your project

echo "module.exports = {extends: ['armour']};" > .commitlintrc.js

or

echo "extends: ['armour']" > .commitlintrc.yml

Define the husky hook in package.json file

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

Contributing

See CONTRIBUTING.md

License

MIT License