git-commit-message-parser

1.1.0 • Public • Published

git-commit-message-parser Build Status

Parse commit messages from a plain string or a stream using a simplified version of the the AngularJS style.

Install

$ npm install --save git-commit-message-parser

API

parser.parse(message) -> Object / Stream

message can be a String or a Stream.

Input
feat(user): allow a user to log in

Allow a user to log in with username and password

Output:

{
  header: {
    type: 'feat',
    scope: 'user',
    subject: 'allow a user to log in'
  },
  body: 'Allow a user to log in with username and password'
}

header.toString() -> String

Stringifies the header back to its original format

Package Sidebar

Install

npm i git-commit-message-parser

Weekly Downloads

1

Version

1.1.0

License

MIT

Last publish

Collaborators

  • bendrucker