npm.io
21.1.0 • Published 5d ago

@commitlint/parse

Licence
MIT
Version
21.1.0
Deps
3
Size
6 kB
Vulns
0
Weekly
8.7M
Stars
18.6K

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
    }

Keywords