peach a19a732be8 commit message 2 years ago
..
lib a19a732be8 commit message 2 years ago
CHANGELOG.md a19a732be8 commit message 2 years ago
README.md a19a732be8 commit message 2 years ago
license.md a19a732be8 commit message 2 years ago
package.json a19a732be8 commit message 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
    }