Wondering what’s next for npm?Check out our public roadmap! »

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

11.0.0 • 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
    }
    

Install

npm i @commitlint/[email protected]

Version

11.0.0

License

MIT

Unpacked Size

10.2 kB

Total Files

8

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar