@commitlint/parse
v19.5.0
Published
Lint your commit messages
Downloads
15,099,914
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
ofconventional-commits-parser
- parserOpts: Options to pass to
parser
{ commentChar: null, // character indicating comment lines issuePrefixes: ['#'] // prefix characters for issue references }