@commitlint/parse

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
  }
  

Similar packages

Other packages similar to @commitlint/parse

conventional-commits-parser

This package is similar to @commitlint/parse as it provides functionality to parse conventional commit messages. It can be used to extract metadata from commit messages following the Conventional Commits specification. It differs in its API and may offer different customization options.