@w5s/conventional-changelog
v2.0.13
Published
Conventional changelog plugin for @w5s
Downloads
4,561
Readme
W5S Commitlint configuration (@w5s/conventional-changelog)
Conventional changelog plugin for @w5s
Installation
npm install --save-dev @w5s/conventional-changelog @commitlint/cli
Usage
In the package.json
of your project
{
"commitlint": {
"extends": ["@w5s/conventional-changelog"]
}
}
Extra rules
{
"commitlint": {
"rules": {
// Rule to validate gitmoji unicode (🐛) or emoji (:bug:)
"type-gitmoji-style": ["error", "always", "unicode" /* | 'emoji' */],
// Rule to validate a gitmoji in the list
"type-valid-gitmoji": ["error", "always"]
}
}
}
Ensure the commitlint
is setup on husky commit message hook (default .husky/commit-msg
)
commitlint --edit $1
# -OR-
npm exec -- commitlint --edit $1
License
MIT © Julien Polo [email protected]