conventional-commits-parser

conventional-commits-parser

Parse raw conventional commits.

Install

# pnpm
pnpm add conventional-commits-parser
# yarn
yarn add conventional-commits-parser
# npm
npm i conventional-commits-parser

Usage

import { CommitParser } from 'conventional-commits-parser'

const parser = new CommitParser()
const commit = parser.parse(
  'feat(scope): broadcast $destroy event on scope destruction\nCloses #1'
)

console.log(commit)
/* {
  type: 'feat',
  scope: 'scope',
  subject: 'broadcast $destroy event on scope destruction',
  header: 'feat(scope): broadcast $destroy event on scope destruction',
  footer: 'Closes #1',
  references: [{
    action: 'Closes',
    issue: '1',
    raw: '#1',
    prefix: '#',
    ...
  }],
  ...
} */

Documentation

For streams and async iterables helpers, parser options, and CLI usage, visit the documentation website.

License

MIT Steve Mao