@newlevelup/commitlint-config
v1.2.0
Published
New Level Up shareable config for commitlint
Downloads
144
Maintainers
Readme
commitlint-config
New Level Up shareable config for commitlint
Installation
💡 The purpose of the
commitlint
is to lint commit messages such that it conforms to the conventional commit format such that it is machine readable. ex.<type>[optional scope]: <description>
Install @newlevelup/commitlint-config
:
yarn add -D @commitlint/cli @newlevelup/commitlint-config
Husky
@newlevelup/commitlint-config
should be used in conjunction with Husky. See the Husky installation guide for more details.
Usage
New Level Up commitlint rules come bundled in @newlevelup/commitlint-config
. To enable these rules, add a commitlint
property in your package.json
. See the commitlint configuration docs for more details.
"commitlint": {
"extends": ["@newlevelup"]
}
Now you can run commitlint by adding the following scripts to your package.json.
"husky": {
"hooks": {
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
}
}