commit-conv v1.0.3

commit-conv

Converts commit messages based on commit conventions.

Documentation

Table of Contents

• commitConv
  • Parameters
  • Examples

commitConv

index.js:36-68

Convert a commit message into one that follows the specified commit convention.

Parameters

• param Object<string> Parameters
  • param.tag string Tag of the commit message (e.g: fix, chore, feat, docs, test, ...) (optional, default required('tag'))
  • param.msg string Header of the commit message (optional, default required('msg'))
  • param.convention string Name of the commit convention (angular, atom, ember, eslint, jshint or none) (optional, default '')

Examples

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'

• Throws Error Invalid convention
• Throws Error Invalid tag in specified convention

Returns string Commit message

Contributions

Please refer to that.

Contributors

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind are welcome!

LICENSE

MIT