@commitlint/parse

@commitlint/parse JS library homepage @commitlint/parse JS library on GitHub @commitlint/parse JS library on npm Download @commitlint/parse JS library

Lint your commit messages

Version 19.8.1 License MIT
@commitlint/parse JS library homepage
@commitlint/parse JS library on GitHub
@commitlint/parse JS library on npm
Download @commitlint/parse JS library
Keywords
conventional-changelogcommitlintlibrarycore

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
    }