Package Exports

@commitlint/parse
@commitlint/parse/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@commitlint/parse) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Parse commit messages to structured data

@commitlint/parse

Install

npm install --save @commitlint/parse

Use

const parse = require('@commitlint/parse');

API

parse(message: string, parser: Function, parserOpts: Object)

message: Commit message to parser
parser: Sync parser function to use. Defaults to sync of conventional-commits-parser

parserOpts: Options to pass to parser

{
  commentChar: null, // character indicating comment lines
  issuePrefixes: ['#'] // prefix characters for issue references
}