Miss any of our Open RFC calls?Watch the recordings here! »

commit-conv

1.0.3 • Public • Published

commit-conv

NPM Downloads Inline docs

NodeVersion GitHub package version devDependencies Status dependencies Status

GH Downloads GitHub commit activity the past year GitHub contributors Github search hit counter

Dependabot Status Build Status codecov.io Code Coverage tested with jest eslint Known Vulnerabilities

All Contributors GitHub contributions welcome Commitizen friendly

GitHub top language GitHub language count GitHub code size in bytes

BCH compliance Codacy Badge semantic-release

Converts commit messages based on commit conventions.

Documentation

Table of Contents

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):

Maximilian Berkmann
Maximilian Berkmann

💻 📖 🤔 🚇 🚧 ⚠️ 💡
Semantic Release Bot
Semantic Release Bot

📦

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

LICENSE

MIT

Install

npm i commit-conv

DownloadsWeekly Downloads

2

Version

1.0.3

License

MIT

Unpacked Size

36.7 kB

Total Files

30

Last publish

Collaborators

  • avatar