commitlint-config-travi
v1.4.53
Published
shareable config for commitlint
Downloads
9,954
Readme
shareable config for commitlint
Purpose
This is my shareable config for commitlint. My config mostly follows angular commit convention, as implemented in the "soft fork" as @commitlint/config-conventional.
Beyond what is implemented in the @commitlint/config-conventional
, I also
enable a type
of wip
for commits that don't fit the default types. This is most often
because the does not complete one of default types, but is instead progress
toward one.
Usage
Installation
$ npm install commitlint-config-travi -D
Define the config for your project
$ echo "module.exports = {extends: ['travi']};" > .commitlintrc.js
Define the husky hook
(in a .huskyrc.json
,
for example)
{
"hooks": {
"commit-msg": "commitlint -e"
}
}