@commitlint/parse

popular esm
Lint your commit messages
Version 19.8.1 License MIT
Keywords
conventional-changelogcommitlintlibrarycore
INSTALL
Type:
Version:
- Static
- Latest Patch
- Latest Minor
- Latest Major
- 19.8.1
- 19.8.0
- 19.5.0
- 19.0.3
- 19.0.0
- 18.6.1
- 18.6.0
- 18.4.4
- 18.4.3
- 18.4.0
- 18.1.0
- 18.0.0
- 17.8.1
- 17.7.0
- 17.6.7
- 17.6.5
- 17.4.4
- 17.4.2
- 17.4.0
- 17.2.0
- 17.0.0
- 16.2.1
- 16.0.0
- 15.0.0
- 14.0.0
- 13.2.0
- 13.1.0
- 13.0.0
- 12.1.4
- 12.1.3
- 12.1.2
- 12.1.1
- 12.1.0
- 12.0.1
- 12.0.0
- 11.0.0
- 10.0.0
- 9.1.2
- 9.1.1
- 9.1.0
- 9.0.1
- 9.0.0
- 8.3.6
- 8.3.4
- 8.3.2
- 8.3.0
- 8.2.0
- 8.1.0
- 8.0.0
- 7.6.0
- 7.5.0
- 7.3.1
- 7.3.0
- 7.1.2
- 7.1.1
- 7.0.0
- 6.1.3
- 6.1.2
- 6.1.1
- 6.1.0
- 6.0.4
- 6.0.3
- 6.0.2
- 6.0.0
- 5.2.8
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 }