lihai 8d6c751f49 feat: push 2 years ago
..
lib 8d6c751f49 feat: push 2 years ago
CHANGELOG.md 8d6c751f49 feat: push 2 years ago
README.md 8d6c751f49 feat: push 2 years ago
license.md 8d6c751f49 feat: push 2 years ago
package.json 8d6c751f49 feat: push 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 of conventional-commits-parser
  • parserOpts: Options to pass to parser { commentChar: null, // character indicating comment lines issuePrefixes: ['#'] // prefix characters for issue references }