@commitlint/parse
TypeScript icon, indicating that this package has built-in type declarations

19.0.3 • Public • Published

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
    }
    

Dependents (18)

Package Sidebar

Install

npm i @commitlint/parse

Weekly Downloads

2,739,542

Version

19.0.3

License

MIT

Unpacked Size

4.62 kB

Total Files

7

Last publish

Collaborators

  • marionebl
  • martinhelmut
  • escapedcat
  • bycedric