You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
2 years ago | |
---|---|---|
.. | ||
lib | 2 years ago | |
README.md | 2 years ago | |
license.md | 2 years ago | |
package.json | 2 years ago |
README.md
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 }