Converts commit messages based on commit conventions.
Convert a commit message into one that follows the specified commit convention
.
param
Object<string> Parametersparam.tag
string Tag of the commit message (e.g:fix
,chore
,feat
,docs
,test
, ...) (optional, defaultrequired('tag')
)param.msg
string Header of the commit message (optional, defaultrequired('msg')
)param.convention
string Name of the commit convention (angular
,atom
,ember
,eslint
,jshint
ornone
) (optional, default''
)
commitConv({tag: 'docs', msg: 'Update README.md', convention: 'angular'}); //'docs: update README.md'
commitConv({tag: 'fix', msg: 'bye bye #1', convention: 'eslint'}); //'Fix: Bye bye #1'
Returns string Commit message
Please refer to that.
Thanks goes to these wonderful people (emoji key):
Maximilian Berkmann 💻 📖 🤔 🚇 🚧 | Semantic Release Bot 📦 |
This project follows the all-contributors specification. Contributions of any kind are welcome!